vericred_client 0.0.6 → 0.0.7

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 (65) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -20
  3. data/docs/CarrierSubsidiary.md +1 -0
  4. data/docs/DrugsApi.md +20 -14
  5. data/docs/NetworksApi.md +17 -4
  6. data/docs/Plan.md +3 -0
  7. data/docs/PlanCounty.md +0 -1
  8. data/docs/PlanCountyBulk.md +0 -1
  9. data/docs/PlanSearchResult.md +3 -0
  10. data/docs/PlanZipCounty.md +10 -0
  11. data/docs/PlansApi.md +17 -2
  12. data/docs/ProvidersApi.md +18 -8
  13. data/docs/RequestPlanFind.md +3 -0
  14. data/docs/ZipCountiesApi.md +10 -7
  15. data/lib/vericred_client/api/drugs_api.rb +7 -18
  16. data/lib/vericred_client/api/networks_api.rb +14 -13
  17. data/lib/vericred_client/api/plans_api.rb +24 -13
  18. data/lib/vericred_client/api/providers_api.rb +7 -15
  19. data/lib/vericred_client/api/zip_counties_api.rb +6 -14
  20. data/lib/vericred_client/api_client.rb +6 -10
  21. data/lib/vericred_client/api_error.rb +5 -10
  22. data/lib/vericred_client/configuration.rb +7 -0
  23. data/lib/vericred_client/models/applicant.rb +5 -10
  24. data/lib/vericred_client/models/base.rb +5 -10
  25. data/lib/vericred_client/models/carrier.rb +5 -10
  26. data/lib/vericred_client/models/carrier_subsidiary.rb +19 -14
  27. data/lib/vericred_client/models/county.rb +5 -10
  28. data/lib/vericred_client/models/county_bulk.rb +5 -10
  29. data/lib/vericred_client/models/drug.rb +5 -10
  30. data/lib/vericred_client/models/drug_coverage.rb +5 -10
  31. data/lib/vericred_client/models/drug_coverage_response.rb +5 -10
  32. data/lib/vericred_client/models/drug_package.rb +5 -10
  33. data/lib/vericred_client/models/drug_search_response.rb +5 -10
  34. data/lib/vericred_client/models/meta.rb +5 -10
  35. data/lib/vericred_client/models/network.rb +5 -10
  36. data/lib/vericred_client/models/network_search_response.rb +5 -10
  37. data/lib/vericred_client/models/plan.rb +36 -11
  38. data/lib/vericred_client/models/plan_county.rb +6 -21
  39. data/lib/vericred_client/models/plan_county_bulk.rb +6 -21
  40. data/lib/vericred_client/models/plan_search_response.rb +5 -10
  41. data/lib/vericred_client/models/plan_search_result.rb +36 -11
  42. data/lib/vericred_client/models/plan_zip_county.rb +313 -0
  43. data/lib/vericred_client/models/pricing.rb +5 -10
  44. data/lib/vericred_client/models/provider.rb +5 -10
  45. data/lib/vericred_client/models/provider_show_response.rb +5 -10
  46. data/lib/vericred_client/models/providers_search_response.rb +5 -10
  47. data/lib/vericred_client/models/rating_area.rb +5 -10
  48. data/lib/vericred_client/models/request_plan_find.rb +36 -11
  49. data/lib/vericred_client/models/request_plan_find_applicant.rb +5 -10
  50. data/lib/vericred_client/models/request_plan_find_provider.rb +5 -10
  51. data/lib/vericred_client/models/request_providers_search.rb +5 -10
  52. data/lib/vericred_client/models/state.rb +5 -10
  53. data/lib/vericred_client/models/zip_code.rb +5 -10
  54. data/lib/vericred_client/models/zip_counties_response.rb +5 -10
  55. data/lib/vericred_client/models/zip_county.rb +5 -10
  56. data/lib/vericred_client/models/zip_county_bulk.rb +5 -10
  57. data/lib/vericred_client/models/zip_county_response.rb +5 -10
  58. data/lib/vericred_client/version.rb +6 -11
  59. data/lib/vericred_client.rb +6 -10
  60. data/spec/api/drugs_api_spec.rb +5 -12
  61. data/spec/api/networks_api_spec.rb +8 -11
  62. data/spec/api/plans_api_spec.rb +14 -11
  63. data/spec/api/providers_api_spec.rb +5 -11
  64. data/spec/api/zip_counties_api_spec.rb +5 -11
  65. metadata +4 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 8f7fabcaedc9fc83577ed750a81f709a96e0ce14
4
- data.tar.gz: 3da9aac61d965345941b57d380973b2074b8d1d4
3
+ metadata.gz: 5884af0b38e9e5508376e896607e0fd1960c6af7
4
+ data.tar.gz: 24343c1bd0d5db668c3213b34811e817cc2f97c6
5
5
  SHA512:
6
- metadata.gz: b37b2440222ec6376dec28c1841e9f393f5412143819afdfd4794acf4c6d431798034297a016067b6421a20fbaecc50342bdfcc75ac9e61fe3e52c710c49ab48
7
- data.tar.gz: 75609434208a29f4897dc2a6338d5847f0196cb9fb3d1ab51daac0a86f86be3820fe05ccae4cbc2b74a7b1a08e0cfd2add97dcbc4958705a8da566a8f494edc7
6
+ metadata.gz: b4675a9be259d83246f13fcc83ab1d199c8f8e165fda308c936a4809ca728b3b4ebd6cecaadf4f570101b4b19c6ac105c47c0b1006602f7da104fa4efe3651f0
7
+ data.tar.gz: c10c49e9609d5c1ad8c39f656b91a09ce14638dc02648f9186d164854e6dd57202bf60713fc6654673461bd43a064f9376c50e2415e68561f2e12ecac72baa9e
data/README.md CHANGED
@@ -32,17 +32,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
32
32
 
33
33
  ## Pagination
34
34
 
35
- Most endpoints are not paginated. It will be noted in the documentation if/when
36
- an endpoint is paginated.
37
-
38
- When pagination is present, a `meta` stanza will be present in the response
39
- with the total number of records
35
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
36
+ four additional fields that contain data about your position in the response,
37
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
40
38
 
41
- ```
42
- {
43
- things: [{ id: 1 }, { id: 2 }],
44
- meta: { total: 500 }
45
- }
39
+ For example, to display 5 results per page and view the second page of a
40
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
46
41
  ```
47
42
 
48
43
  ## Sideloading
@@ -120,8 +115,8 @@ The response would be
120
115
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
121
116
 
122
117
  - API version: 1.0.0
123
- - Package version: 0.0.6
124
- - Build date: 2016-06-01T14:01:54.755-04:00
118
+ - Package version: 0.0.7
119
+ - Build date: 2016-06-27T13:45:34.446-04:00
125
120
  - Build package: class io.swagger.codegen.languages.RubyClientCodegen
126
121
 
127
122
  ## Installation
@@ -137,15 +132,15 @@ gem build vericred_client.gemspec
137
132
  Then either install the gem locally:
138
133
 
139
134
  ```shell
140
- gem install ./vericred_client-0.0.6.gem
135
+ gem install ./vericred_client-0.0.7.gem
141
136
  ```
142
- (for development, run `gem install --dev ./vericred_client-0.0.6.gem` to install the development dependencies)
137
+ (for development, run `gem install --dev ./vericred_client-0.0.7.gem` to install the development dependencies)
143
138
 
144
139
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
145
140
 
146
141
  Finally add this to the Gemfile:
147
142
 
148
- gem 'vericred_client', '~> 0.0.6'
143
+ gem 'vericred_client', '~> 0.0.7'
149
144
 
150
145
  ### Install from Git
151
146
 
@@ -168,6 +163,14 @@ Please follow the [installation](#installation) procedure and then run the follo
168
163
  # Load the gem
169
164
  require 'vericred_client'
170
165
 
166
+ # Setup authorization
167
+ VericredClient.configure do |config|
168
+ # Configure API key authorization: Vericred-Api-Key
169
+ config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
170
+ # Uncomment the following line to set a prefix for the API key, e.g. 'BEARER' (defaults to nil)
171
+ #config.api_key_prefix['Vericred-Api-Key'] = 'BEARER'
172
+ end
173
+
171
174
  api_instance = VericredClient::DrugsApi.new
172
175
 
173
176
  ndc_package_code = "12345-4321-11" # String | NDC package code
@@ -176,13 +179,10 @@ audience = "individual" # String | Two-character state code
176
179
 
177
180
  state_code = "NY" # String | Two-character state code
178
181
 
179
- opts = {
180
- vericred_api_key: "api-doc-key" # String | API Key
181
- }
182
182
 
183
183
  begin
184
184
  #Search for DrugCoverages
185
- result = api_instance.get_drug_coverages(ndc_package_code, audience, state_code, opts)
185
+ result = api_instance.get_drug_coverages(ndc_package_code, audience, state_code)
186
186
  p result
187
187
  rescue VericredClient::ApiError => e
188
188
  puts "Exception when calling DrugsApi->get_drug_coverages: #{e}"
@@ -226,6 +226,7 @@ Class | Method | HTTP request | Description
226
226
  - [VericredClient::PlanCountyBulk](docs/PlanCountyBulk.md)
227
227
  - [VericredClient::PlanSearchResponse](docs/PlanSearchResponse.md)
228
228
  - [VericredClient::PlanSearchResult](docs/PlanSearchResult.md)
229
+ - [VericredClient::PlanZipCounty](docs/PlanZipCounty.md)
229
230
  - [VericredClient::Pricing](docs/Pricing.md)
230
231
  - [VericredClient::Provider](docs/Provider.md)
231
232
  - [VericredClient::ProviderShowResponse](docs/ProviderShowResponse.md)
@@ -245,5 +246,10 @@ Class | Method | HTTP request | Description
245
246
 
246
247
  ## Documentation for Authorization
247
248
 
248
- All endpoints do not require authorization.
249
+
250
+ ### Vericred-Api-Key
251
+
252
+ - **Type**: API key
253
+ - **API key parameter name**: Vericred-Api-Key
254
+ - **Location**: HTTP header
249
255
 
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **id** | **Integer** | Primary key | [optional]
7
7
  **name** | **String** | Subsidiary name | [optional]
8
+ **alternate_name** | **String** | Parent Carrier Name | [optional]
8
9
 
9
10
 
data/docs/DrugsApi.md CHANGED
@@ -9,7 +9,7 @@ Method | HTTP request | Description
9
9
 
10
10
 
11
11
  # **get_drug_coverages**
12
- > DrugCoverageResponse get_drug_coverages(ndc_package_code, audience, state_code, opts)
12
+ > DrugCoverageResponse get_drug_coverages(ndc_package_code, audience, state_code)
13
13
 
14
14
  Search for DrugCoverages
15
15
 
@@ -21,6 +21,13 @@ returns all DrugCoverages for a given Drug
21
21
  ```ruby
22
22
  # load the gem
23
23
  require 'vericred_client'
24
+ # setup authorization
25
+ VericredClient.configure do |config|
26
+ # Configure API key authorization: Vericred-Api-Key
27
+ config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
28
+ # Uncomment the following line to set a prefix for the API key, e.g. 'BEARER' (defaults to nil)
29
+ #config.api_key_prefix['Vericred-Api-Key'] = 'BEARER'
30
+ end
24
31
 
25
32
  api_instance = VericredClient::DrugsApi.new
26
33
 
@@ -30,13 +37,10 @@ audience = "individual" # String | Two-character state code
30
37
 
31
38
  state_code = "NY" # String | Two-character state code
32
39
 
33
- opts = {
34
- vericred_api_key: "api-doc-key" # String | API Key
35
- }
36
40
 
37
41
  begin
38
42
  #Search for DrugCoverages
39
- result = api_instance.get_drug_coverages(ndc_package_code, audience, state_code, opts)
43
+ result = api_instance.get_drug_coverages(ndc_package_code, audience, state_code)
40
44
  p result
41
45
  rescue VericredClient::ApiError => e
42
46
  puts "Exception when calling DrugsApi->get_drug_coverages: #{e}"
@@ -50,7 +54,6 @@ Name | Type | Description | Notes
50
54
  **ndc_package_code** | **String**| NDC package code |
51
55
  **audience** | **String**| Two-character state code |
52
56
  **state_code** | **String**| Two-character state code |
53
- **vericred_api_key** | **String**| API Key | [optional]
54
57
 
55
58
  ### Return type
56
59
 
@@ -58,7 +61,7 @@ Name | Type | Description | Notes
58
61
 
59
62
  ### Authorization
60
63
 
61
- No authorization required
64
+ [Vericred-Api-Key](../README.md#Vericred-Api-Key)
62
65
 
63
66
  ### HTTP request headers
64
67
 
@@ -68,7 +71,7 @@ No authorization required
68
71
 
69
72
 
70
73
  # **list_drugs**
71
- > DrugSearchResponse list_drugs(search_term, opts)
74
+ > DrugSearchResponse list_drugs(search_term)
72
75
 
73
76
  Drug Search
74
77
 
@@ -78,18 +81,22 @@ Search for drugs by proprietary name
78
81
  ```ruby
79
82
  # load the gem
80
83
  require 'vericred_client'
84
+ # setup authorization
85
+ VericredClient.configure do |config|
86
+ # Configure API key authorization: Vericred-Api-Key
87
+ config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
88
+ # Uncomment the following line to set a prefix for the API key, e.g. 'BEARER' (defaults to nil)
89
+ #config.api_key_prefix['Vericred-Api-Key'] = 'BEARER'
90
+ end
81
91
 
82
92
  api_instance = VericredClient::DrugsApi.new
83
93
 
84
94
  search_term = "Zyrtec" # String | Full or partial proprietary name of drug
85
95
 
86
- opts = {
87
- vericred_api_key: "api-doc-key" # String | API Key
88
- }
89
96
 
90
97
  begin
91
98
  #Drug Search
92
- result = api_instance.list_drugs(search_term, opts)
99
+ result = api_instance.list_drugs(search_term)
93
100
  p result
94
101
  rescue VericredClient::ApiError => e
95
102
  puts "Exception when calling DrugsApi->list_drugs: #{e}"
@@ -101,7 +108,6 @@ end
101
108
  Name | Type | Description | Notes
102
109
  ------------- | ------------- | ------------- | -------------
103
110
  **search_term** | **String**| Full or partial proprietary name of drug |
104
- **vericred_api_key** | **String**| API Key | [optional]
105
111
 
106
112
  ### Return type
107
113
 
@@ -109,7 +115,7 @@ Name | Type | Description | Notes
109
115
 
110
116
  ### Authorization
111
117
 
112
- No authorization required
118
+ [Vericred-Api-Key](../README.md#Vericred-Api-Key)
113
119
 
114
120
  ### HTTP request headers
115
121
 
data/docs/NetworksApi.md CHANGED
@@ -8,27 +8,38 @@ Method | HTTP request | Description
8
8
 
9
9
 
10
10
  # **list_networks**
11
- > NetworkSearchResponse list_networks(carrier_id)
11
+ > NetworkSearchResponse list_networks(carrier_id, opts)
12
12
 
13
13
  Networks
14
14
 
15
15
  A network is a list of the doctors, other health care providers,
16
16
  and hospitals that a plan has contracted with to provide medical care to
17
- its members.
17
+ its members. This endpoint is paginated.
18
18
 
19
19
  ### Example
20
20
  ```ruby
21
21
  # load the gem
22
22
  require 'vericred_client'
23
+ # setup authorization
24
+ VericredClient.configure do |config|
25
+ # Configure API key authorization: Vericred-Api-Key
26
+ config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
27
+ # Uncomment the following line to set a prefix for the API key, e.g. 'BEARER' (defaults to nil)
28
+ #config.api_key_prefix['Vericred-Api-Key'] = 'BEARER'
29
+ end
23
30
 
24
31
  api_instance = VericredClient::NetworksApi.new
25
32
 
26
33
  carrier_id = "33333" # String | Carrier HIOS Issuer ID
27
34
 
35
+ opts = {
36
+ page: 1, # Integer | Page of paginated response
37
+ per_page: 1 # Integer | Responses per page
38
+ }
28
39
 
29
40
  begin
30
41
  #Networks
31
- result = api_instance.list_networks(carrier_id)
42
+ result = api_instance.list_networks(carrier_id, opts)
32
43
  p result
33
44
  rescue VericredClient::ApiError => e
34
45
  puts "Exception when calling NetworksApi->list_networks: #{e}"
@@ -40,6 +51,8 @@ end
40
51
  Name | Type | Description | Notes
41
52
  ------------- | ------------- | ------------- | -------------
42
53
  **carrier_id** | **String**| Carrier HIOS Issuer ID |
54
+ **page** | **Integer**| Page of paginated response | [optional]
55
+ **per_page** | **Integer**| Responses per page | [optional]
43
56
 
44
57
  ### Return type
45
58
 
@@ -47,7 +60,7 @@ Name | Type | Description | Notes
47
60
 
48
61
  ### Authorization
49
62
 
50
- No authorization required
63
+ [Vericred-Api-Key](../README.md#Vericred-Api-Key)
51
64
 
52
65
  ### HTTP request headers
53
66
 
data/docs/Plan.md CHANGED
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **adult_dental** | **BOOLEAN** | Does the plan provide dental coverage for adults? | [optional]
7
+ **age29_rider** | **BOOLEAN** | | [optional]
7
8
  **ambulance** | **String** | Benefits string for ambulance coverage | [optional]
8
9
  **benefits_summary_url** | **String** | Link to the summary of benefits and coverage (SBC) document. | [optional]
9
10
  **buy_link** | **String** | Link to a location to purchase the plan. | [optional]
@@ -14,6 +15,7 @@ Name | Type | Description | Notes
14
15
  **customer_service_phone_number** | **String** | Phone number to contact the insurance carrier | [optional]
15
16
  **durable_medical_equipment** | **String** | Benefits summary for durable medical equipment | [optional]
16
17
  **diagnostic_test** | **String** | Diagnostic tests benefit summary | [optional]
18
+ **dp_rider** | **BOOLEAN** | Is this a domestic plan? | [optional]
17
19
  **drug_formulary_url** | **String** | Link to the summary of drug benefits for the plan | [optional]
18
20
  **effective_date** | **String** | Effective date of coverage. | [optional]
19
21
  **expiration_date** | **String** | Expiration date of coverage. | [optional]
@@ -22,6 +24,7 @@ Name | Type | Description | Notes
22
24
  **family_drug_moop** | **String** | Maximum out-of-pocket for drugs when a family is on the plan | [optional]
23
25
  **family_medical_deductible** | **String** | Deductible when a family is on the plan | [optional]
24
26
  **family_medical_moop** | **String** | Maximum out-of-pocket when a family is on the plan | [optional]
27
+ **fp_rider** | **BOOLEAN** | Is this a family plan? | [optional]
25
28
  **generic_drugs** | **String** | Cost for generic drugs | [optional]
26
29
  **habilitation_services** | **String** | Habilitation services benefits summary | [optional]
27
30
  **hios_issuer_id** | **String** | | [optional]
data/docs/PlanCounty.md CHANGED
@@ -3,7 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **id** | **Integer** | Primary key | [optional]
7
6
  **plan_id** | **Integer** | Foreign key to plan | [optional]
8
7
  **county_id** | **Integer** | Foreign key to county | [optional]
9
8
 
@@ -3,7 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **id** | **Integer** | Primary key | [optional]
7
6
  **plan_id** | **Integer** | Foreign key to plan | [optional]
8
7
  **county_id** | **Integer** | Foreign key to county | [optional]
9
8
 
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **adult_dental** | **BOOLEAN** | Does the plan provide dental coverage for adults? | [optional]
7
+ **age29_rider** | **BOOLEAN** | | [optional]
7
8
  **ambulance** | **String** | Benefits string for ambulance coverage | [optional]
8
9
  **benefits_summary_url** | **String** | Link to the summary of benefits and coverage (SBC) document. | [optional]
9
10
  **buy_link** | **String** | Link to a location to purchase the plan. | [optional]
@@ -14,6 +15,7 @@ Name | Type | Description | Notes
14
15
  **customer_service_phone_number** | **String** | Phone number to contact the insurance carrier | [optional]
15
16
  **durable_medical_equipment** | **String** | Benefits summary for durable medical equipment | [optional]
16
17
  **diagnostic_test** | **String** | Diagnostic tests benefit summary | [optional]
18
+ **dp_rider** | **BOOLEAN** | Is this a domestic plan? | [optional]
17
19
  **drug_formulary_url** | **String** | Link to the summary of drug benefits for the plan | [optional]
18
20
  **effective_date** | **String** | Effective date of coverage. | [optional]
19
21
  **expiration_date** | **String** | Expiration date of coverage. | [optional]
@@ -22,6 +24,7 @@ Name | Type | Description | Notes
22
24
  **family_drug_moop** | **String** | Maximum out-of-pocket for drugs when a family is on the plan | [optional]
23
25
  **family_medical_deductible** | **String** | Deductible when a family is on the plan | [optional]
24
26
  **family_medical_moop** | **String** | Maximum out-of-pocket when a family is on the plan | [optional]
27
+ **fp_rider** | **BOOLEAN** | Is this a family plan? | [optional]
25
28
  **generic_drugs** | **String** | Cost for generic drugs | [optional]
26
29
  **habilitation_services** | **String** | Habilitation services benefits summary | [optional]
27
30
  **hios_issuer_id** | **String** | | [optional]
@@ -0,0 +1,10 @@
1
+ # VericredClient::PlanZipCounty
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **plan_id** | **Integer** | Foreign key to plan | [optional]
7
+ **county_id** | **Integer** | Foreign key to county | [optional]
8
+ **zip_code_id** | **Integer** | Foreign key to zip code | [optional]
9
+
10
+
data/docs/PlansApi.md CHANGED
@@ -16,7 +16,7 @@ Find Plans
16
16
 
17
17
  Searching for a set of plans requires a `zip_code` and `fips_code`
18
18
  code. These are used to determine pricing and availabity
19
- of health plans.
19
+ of health plans. This endpoint is paginated.
20
20
 
21
21
  Optionally, you may provide a list of Applicants or Providers
22
22
 
@@ -74,10 +74,25 @@ and return it for each plan. If no values are provided, the
74
74
  `GET /plans?zip_code=07451&fips_code=33025&household_size=4&household_income=40000`
75
75
 
76
76
 
77
+ ### Sorting
78
+
79
+ Plans can be sorted by the `premium`, `carrier_name`, `level`, and `plan_type` fields,
80
+ by either ascending (as `asc`) or descending (as `dsc) sort under the `sort` field.
81
+
82
+ For example, to sort plans by level, the sort parameter would be `level:asc`.
83
+
84
+
77
85
  ### Example
78
86
  ```ruby
79
87
  # load the gem
80
88
  require 'vericred_client'
89
+ # setup authorization
90
+ VericredClient.configure do |config|
91
+ # Configure API key authorization: Vericred-Api-Key
92
+ config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
93
+ # Uncomment the following line to set a prefix for the API key, e.g. 'BEARER' (defaults to nil)
94
+ #config.api_key_prefix['Vericred-Api-Key'] = 'BEARER'
95
+ end
81
96
 
82
97
  api_instance = VericredClient::PlansApi.new
83
98
 
@@ -106,7 +121,7 @@ Name | Type | Description | Notes
106
121
 
107
122
  ### Authorization
108
123
 
109
- No authorization required
124
+ [Vericred-Api-Key](../README.md#Vericred-Api-Key)
110
125
 
111
126
  ### HTTP request headers
112
127
 
data/docs/ProvidersApi.md CHANGED
@@ -9,7 +9,7 @@ Method | HTTP request | Description
9
9
 
10
10
 
11
11
  # **get_provider**
12
- > ProviderShowResponse get_provider(npi, opts)
12
+ > ProviderShowResponse get_provider(npi)
13
13
 
14
14
  Find a Provider
15
15
 
@@ -19,18 +19,22 @@ To retrieve a specific provider, just perform a GET using his NPI number
19
19
  ```ruby
20
20
  # load the gem
21
21
  require 'vericred_client'
22
+ # setup authorization
23
+ VericredClient.configure do |config|
24
+ # Configure API key authorization: Vericred-Api-Key
25
+ config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
26
+ # Uncomment the following line to set a prefix for the API key, e.g. 'BEARER' (defaults to nil)
27
+ #config.api_key_prefix['Vericred-Api-Key'] = 'BEARER'
28
+ end
22
29
 
23
30
  api_instance = VericredClient::ProvidersApi.new
24
31
 
25
32
  npi = "1234567890" # String | NPI number
26
33
 
27
- opts = {
28
- vericred_api_key: "api-doc-key" # String | API Key
29
- }
30
34
 
31
35
  begin
32
36
  #Find a Provider
33
- result = api_instance.get_provider(npi, opts)
37
+ result = api_instance.get_provider(npi)
34
38
  p result
35
39
  rescue VericredClient::ApiError => e
36
40
  puts "Exception when calling ProvidersApi->get_provider: #{e}"
@@ -42,7 +46,6 @@ end
42
46
  Name | Type | Description | Notes
43
47
  ------------- | ------------- | ------------- | -------------
44
48
  **npi** | **String**| NPI number |
45
- **vericred_api_key** | **String**| API Key | [optional]
46
49
 
47
50
  ### Return type
48
51
 
@@ -50,7 +53,7 @@ Name | Type | Description | Notes
50
53
 
51
54
  ### Authorization
52
55
 
53
- No authorization required
56
+ [Vericred-Api-Key](../README.md#Vericred-Api-Key)
54
57
 
55
58
  ### HTTP request headers
56
59
 
@@ -83,6 +86,13 @@ Specialty name search. So, searching "John Smith nose" would return
83
86
  ```ruby
84
87
  # load the gem
85
88
  require 'vericred_client'
89
+ # setup authorization
90
+ VericredClient.configure do |config|
91
+ # Configure API key authorization: Vericred-Api-Key
92
+ config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
93
+ # Uncomment the following line to set a prefix for the API key, e.g. 'BEARER' (defaults to nil)
94
+ #config.api_key_prefix['Vericred-Api-Key'] = 'BEARER'
95
+ end
86
96
 
87
97
  api_instance = VericredClient::ProvidersApi.new
88
98
 
@@ -111,7 +121,7 @@ Name | Type | Description | Notes
111
121
 
112
122
  ### Authorization
113
123
 
114
- No authorization required
124
+ [Vericred-Api-Key](../README.md#Vericred-Api-Key)
115
125
 
116
126
  ### HTTP request headers
117
127
 
@@ -11,6 +11,9 @@ Name | Type | Description | Notes
11
11
  **household_size** | **Integer** | Number of people living in household. | [optional]
12
12
  **market** | **String** | Type of plan to search for. | [optional]
13
13
  **providers** | [**Array<RequestPlanFindProvider>**](RequestPlanFindProvider.md) | List of providers to search for. | [optional]
14
+ **page** | **Integer** | Selected page of paginated response. | [optional]
15
+ **per_page** | **Integer** | Results per page of response. | [optional]
16
+ **sort** | **String** | Sort responses by plan field. | [optional]
14
17
  **zip_code** | **String** | 5-digit zip code - this helps determine pricing. | [optional]
15
18
 
16
19
 
@@ -8,7 +8,7 @@ Method | HTTP request | Description
8
8
 
9
9
 
10
10
  # **get_zip_counties**
11
- > ZipCountyResponse get_zip_counties(zip_prefix, opts)
11
+ > ZipCountyResponse get_zip_counties(zip_prefix)
12
12
 
13
13
  Search for Zip Counties
14
14
 
@@ -18,18 +18,22 @@ Our `Plan` endpoints require a zip code and a fips (county) code. This is becau
18
18
  ```ruby
19
19
  # load the gem
20
20
  require 'vericred_client'
21
+ # setup authorization
22
+ VericredClient.configure do |config|
23
+ # Configure API key authorization: Vericred-Api-Key
24
+ config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
25
+ # Uncomment the following line to set a prefix for the API key, e.g. 'BEARER' (defaults to nil)
26
+ #config.api_key_prefix['Vericred-Api-Key'] = 'BEARER'
27
+ end
21
28
 
22
29
  api_instance = VericredClient::ZipCountiesApi.new
23
30
 
24
31
  zip_prefix = "1002" # String | Partial five-digit Zip
25
32
 
26
- opts = {
27
- vericred_api_key: "api-doc-key" # String | API Key
28
- }
29
33
 
30
34
  begin
31
35
  #Search for Zip Counties
32
- result = api_instance.get_zip_counties(zip_prefix, opts)
36
+ result = api_instance.get_zip_counties(zip_prefix)
33
37
  p result
34
38
  rescue VericredClient::ApiError => e
35
39
  puts "Exception when calling ZipCountiesApi->get_zip_counties: #{e}"
@@ -41,7 +45,6 @@ end
41
45
  Name | Type | Description | Notes
42
46
  ------------- | ------------- | ------------- | -------------
43
47
  **zip_prefix** | **String**| Partial five-digit Zip |
44
- **vericred_api_key** | **String**| API Key | [optional]
45
48
 
46
49
  ### Return type
47
50
 
@@ -49,7 +52,7 @@ Name | Type | Description | Notes
49
52
 
50
53
  ### Authorization
51
54
 
52
- No authorization required
55
+ [Vericred-Api-Key](../README.md#Vericred-Api-Key)
53
56
 
54
57
  ### HTTP request headers
55
58
 
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -141,7 +136,6 @@ returns all DrugCoverages for a given Drug
141
136
  # @param audience Two-character state code
142
137
  # @param state_code Two-character state code
143
138
  # @param [Hash] opts the optional parameters
144
- # @option opts [String] :vericred_api_key API Key
145
139
  # @return [DrugCoverageResponse]
146
140
  def get_drug_coverages(ndc_package_code, audience, state_code, opts = {})
147
141
  data, _status_code, _headers = get_drug_coverages_with_http_info(ndc_package_code, audience, state_code, opts)
@@ -156,7 +150,6 @@ returns all DrugCoverages for a given Drug
156
150
  # @param audience Two-character state code
157
151
  # @param state_code Two-character state code
158
152
  # @param [Hash] opts the optional parameters
159
- # @option opts [String] :vericred_api_key API Key
160
153
  # @return [Array<(DrugCoverageResponse, Fixnum, Hash)>] DrugCoverageResponse data, response status code and response headers
161
154
  def get_drug_coverages_with_http_info(ndc_package_code, audience, state_code, opts = {})
162
155
  if @api_client.config.debugging
@@ -186,14 +179,13 @@ returns all DrugCoverages for a given Drug
186
179
  # HTTP header 'Content-Type'
187
180
  local_header_content_type = []
188
181
  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']
190
182
 
191
183
  # form parameters
192
184
  form_params = {}
193
185
 
194
186
  # http body (model)
195
187
  post_body = nil
196
- auth_names = []
188
+ auth_names = ['Vericred-Api-Key']
197
189
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
198
190
  :header_params => header_params,
199
191
  :query_params => query_params,
@@ -211,7 +203,6 @@ returns all DrugCoverages for a given Drug
211
203
  # Search for drugs by proprietary name
212
204
  # @param search_term Full or partial proprietary name of drug
213
205
  # @param [Hash] opts the optional parameters
214
- # @option opts [String] :vericred_api_key API Key
215
206
  # @return [DrugSearchResponse]
216
207
  def list_drugs(search_term, opts = {})
217
208
  data, _status_code, _headers = list_drugs_with_http_info(search_term, opts)
@@ -222,7 +213,6 @@ returns all DrugCoverages for a given Drug
222
213
  # Search for drugs by proprietary name
223
214
  # @param search_term Full or partial proprietary name of drug
224
215
  # @param [Hash] opts the optional parameters
225
- # @option opts [String] :vericred_api_key API Key
226
216
  # @return [Array<(DrugSearchResponse, Fixnum, Hash)>] DrugSearchResponse data, response status code and response headers
227
217
  def list_drugs_with_http_info(search_term, opts = {})
228
218
  if @api_client.config.debugging
@@ -247,14 +237,13 @@ returns all DrugCoverages for a given Drug
247
237
  # HTTP header 'Content-Type'
248
238
  local_header_content_type = ['application/json']
249
239
  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
240
 
252
241
  # form parameters
253
242
  form_params = {}
254
243
 
255
244
  # http body (model)
256
245
  post_body = nil
257
- auth_names = []
246
+ auth_names = ['Vericred-Api-Key']
258
247
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
259
248
  :header_params => header_params,
260
249
  :query_params => query_params,