vericred_client 0.0.8 → 0.0.9

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 (43) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +10 -6
  3. data/docs/CountyBulk.md +2 -0
  4. data/docs/Plan.md +3 -0
  5. data/docs/PlanSearchResult.md +3 -0
  6. data/docs/PlanShowResponse.md +8 -0
  7. data/docs/PlansApi.md +56 -0
  8. data/docs/ProvidersApi.md +8 -2
  9. data/docs/RequestPlanFind.md +2 -1
  10. data/docs/RequestPlanFindDrugPackage.md +8 -0
  11. data/docs/RequestProvidersSearch.md +1 -0
  12. data/docs/ServiceArea.md +10 -0
  13. data/docs/ServiceAreaZipCounty.md +10 -0
  14. data/lib/vericred_client/api/plans_api.rb +56 -0
  15. data/lib/vericred_client/api/providers_api.rb +6 -0
  16. data/lib/vericred_client/api_client.rb +9 -3
  17. data/lib/vericred_client/configuration.rb +22 -1
  18. data/lib/vericred_client/models/county_bulk.rb +24 -4
  19. data/lib/vericred_client/models/plan.rb +31 -1
  20. data/lib/vericred_client/models/plan_search_result.rb +31 -1
  21. data/lib/vericred_client/models/plan_show_response.rb +307 -0
  22. data/lib/vericred_client/models/request_plan_find.rb +14 -2
  23. data/lib/vericred_client/models/request_plan_find_drug_package.rb +307 -0
  24. data/lib/vericred_client/models/request_providers_search.rb +11 -1
  25. data/lib/vericred_client/models/service_area.rb +327 -0
  26. data/lib/vericred_client/models/{plan_zip_county.rb → service_area_zip_county.rb} +14 -14
  27. data/lib/vericred_client/version.rb +1 -1
  28. data/lib/vericred_client.rb +4 -1
  29. data/spec/api/plans_api_spec.rb +12 -0
  30. data/spec/api/providers_api_spec.rb +2 -0
  31. data/spec/api_client_spec.rb +20 -79
  32. data/spec/configuration_spec.rb +11 -6
  33. data/spec/models/county_bulk_spec.rb +12 -0
  34. data/spec/models/plan_search_result_spec.rb +18 -0
  35. data/spec/models/plan_show_response_spec.rb +160 -0
  36. data/spec/models/plan_spec.rb +18 -0
  37. data/spec/models/request_plan_find_drug_package_spec.rb +160 -0
  38. data/spec/models/request_plan_find_spec.rb +6 -0
  39. data/spec/models/request_providers_search_spec.rb +6 -0
  40. data/spec/models/service_area_spec.rb +172 -0
  41. data/spec/models/{plan_zip_county_spec.rb → service_area_zip_county_spec.rb} +8 -8
  42. metadata +18 -6
  43. data/docs/PlanZipCounty.md +0 -10
@@ -0,0 +1,160 @@
1
+ =begin
2
+ #Vericred API
3
+
4
+ #Vericred's API allows you to search for Health Plans that a specific doctor
5
+ accepts.
6
+
7
+ ## Getting Started
8
+
9
+ Visit our [Developer Portal](https://vericred.3scale.net) to
10
+ create an account.
11
+
12
+ Once you have created an account, you can create one Application for
13
+ Production and another for our Sandbox (select the appropriate Plan when
14
+ you create the Application).
15
+
16
+ ## Authentication
17
+
18
+ To authenticate, pass the API Key you created in the Developer Portal as
19
+ a `Vericred-Api-Key` header.
20
+
21
+ `curl -H 'Vericred-Api-Key: YOUR_KEY' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
22
+
23
+ ## Versioning
24
+
25
+ Vericred's API default to the latest version. However, if you need a specific
26
+ version, you can request it with an `Accept-Version` header.
27
+
28
+ The current version is `v3`. Previous versions are `v1` and `v2`.
29
+
30
+ `curl -H 'Vericred-Api-Key: YOUR_KEY' -H 'Accept-Version: v2' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
31
+
32
+ ## Pagination
33
+
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).
37
+
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`.
40
+
41
+ ## Sideloading
42
+
43
+ When we return multiple levels of an object graph (e.g. `Provider`s and their `State`s
44
+ we sideload the associated data. In this example, we would provide an Array of
45
+ `State`s and a `state_id` for each provider. This is done primarily to reduce the
46
+ payload size since many of the `Provider`s will share a `State`
47
+
48
+ ```
49
+ {
50
+ providers: [{ id: 1, state_id: 1}, { id: 2, state_id: 1 }],
51
+ states: [{ id: 1, code: 'NY' }]
52
+ }
53
+ ```
54
+
55
+ If you need the second level of the object graph, you can just match the
56
+ corresponding id.
57
+
58
+ ## Selecting specific data
59
+
60
+ All endpoints allow you to specify which fields you would like to return.
61
+ This allows you to limit the response to contain only the data you need.
62
+
63
+ For example, let's take a request that returns the following JSON by default
64
+
65
+ ```
66
+ {
67
+ provider: {
68
+ id: 1,
69
+ name: 'John',
70
+ phone: '1234567890',
71
+ field_we_dont_care_about: 'value_we_dont_care_about'
72
+ },
73
+ states: [{
74
+ id: 1,
75
+ name: 'New York',
76
+ code: 'NY',
77
+ field_we_dont_care_about: 'value_we_dont_care_about'
78
+ }]
79
+ }
80
+ ```
81
+
82
+ To limit our results to only return the fields we care about, we specify the
83
+ `select` query string parameter for the corresponding fields in the JSON
84
+ document.
85
+
86
+ In this case, we want to select `name` and `phone` from the `provider` key,
87
+ so we would add the parameters `select=provider.name,provider.phone`.
88
+ We also want the `name` and `code` from the `states` key, so we would
89
+ add the parameters `select=states.name,staes.code`. The id field of
90
+ each document is always returned whether or not it is requested.
91
+
92
+ Our final request would be `GET /providers/12345?select=provider.name,provider.phone,states.name,states.code`
93
+
94
+ The response would be
95
+
96
+ ```
97
+ {
98
+ provider: {
99
+ id: 1,
100
+ name: 'John',
101
+ phone: '1234567890'
102
+ },
103
+ states: [{
104
+ id: 1,
105
+ name: 'New York',
106
+ code: 'NY'
107
+ }]
108
+ }
109
+ ```
110
+
111
+
112
+
113
+ OpenAPI spec version: 1.0.0
114
+
115
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
116
+
117
+ Licensed under the Apache License, Version 2.0 (the "License");
118
+ you may not use this file except in compliance with the License.
119
+ You may obtain a copy of the License at
120
+
121
+ http://www.apache.org/licenses/LICENSE-2.0
122
+
123
+ Unless required by applicable law or agreed to in writing, software
124
+ distributed under the License is distributed on an "AS IS" BASIS,
125
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
126
+ See the License for the specific language governing permissions and
127
+ limitations under the License.
128
+
129
+ =end
130
+
131
+ require 'spec_helper'
132
+ require 'json'
133
+ require 'date'
134
+
135
+ # Unit tests for VericredClient::RequestPlanFindDrugPackage
136
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
137
+ # Please update as you see appropriate
138
+ describe 'RequestPlanFindDrugPackage' do
139
+ before do
140
+ # run before each test
141
+ @instance = VericredClient::RequestPlanFindDrugPackage.new
142
+ end
143
+
144
+ after do
145
+ # run after each test
146
+ end
147
+
148
+ describe 'test an instance of RequestPlanFindDrugPackage' do
149
+ it 'should create an instact of RequestPlanFindDrugPackage' do
150
+ expect(@instance).to be_instance_of(VericredClient::RequestPlanFindDrugPackage)
151
+ end
152
+ end
153
+ describe 'test attribute "id"' do
154
+ it 'should work' do
155
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
156
+ end
157
+ end
158
+
159
+ end
160
+
@@ -186,6 +186,12 @@ describe 'RequestPlanFind' do
186
186
  end
187
187
  end
188
188
 
189
+ describe 'test attribute "ids"' do
190
+ it 'should work' do
191
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
192
+ end
193
+ end
194
+
189
195
  describe 'test attribute "market"' do
190
196
  it 'should work' do
191
197
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -162,6 +162,12 @@ describe 'RequestProvidersSearch' do
162
162
  end
163
163
  end
164
164
 
165
+ describe 'test attribute "min_score"' do
166
+ it 'should work' do
167
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
168
+ end
169
+ end
170
+
165
171
  describe 'test attribute "page"' do
166
172
  it 'should work' do
167
173
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -0,0 +1,172 @@
1
+ =begin
2
+ #Vericred API
3
+
4
+ #Vericred's API allows you to search for Health Plans that a specific doctor
5
+ accepts.
6
+
7
+ ## Getting Started
8
+
9
+ Visit our [Developer Portal](https://vericred.3scale.net) to
10
+ create an account.
11
+
12
+ Once you have created an account, you can create one Application for
13
+ Production and another for our Sandbox (select the appropriate Plan when
14
+ you create the Application).
15
+
16
+ ## Authentication
17
+
18
+ To authenticate, pass the API Key you created in the Developer Portal as
19
+ a `Vericred-Api-Key` header.
20
+
21
+ `curl -H 'Vericred-Api-Key: YOUR_KEY' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
22
+
23
+ ## Versioning
24
+
25
+ Vericred's API default to the latest version. However, if you need a specific
26
+ version, you can request it with an `Accept-Version` header.
27
+
28
+ The current version is `v3`. Previous versions are `v1` and `v2`.
29
+
30
+ `curl -H 'Vericred-Api-Key: YOUR_KEY' -H 'Accept-Version: v2' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
31
+
32
+ ## Pagination
33
+
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).
37
+
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`.
40
+
41
+ ## Sideloading
42
+
43
+ When we return multiple levels of an object graph (e.g. `Provider`s and their `State`s
44
+ we sideload the associated data. In this example, we would provide an Array of
45
+ `State`s and a `state_id` for each provider. This is done primarily to reduce the
46
+ payload size since many of the `Provider`s will share a `State`
47
+
48
+ ```
49
+ {
50
+ providers: [{ id: 1, state_id: 1}, { id: 2, state_id: 1 }],
51
+ states: [{ id: 1, code: 'NY' }]
52
+ }
53
+ ```
54
+
55
+ If you need the second level of the object graph, you can just match the
56
+ corresponding id.
57
+
58
+ ## Selecting specific data
59
+
60
+ All endpoints allow you to specify which fields you would like to return.
61
+ This allows you to limit the response to contain only the data you need.
62
+
63
+ For example, let's take a request that returns the following JSON by default
64
+
65
+ ```
66
+ {
67
+ provider: {
68
+ id: 1,
69
+ name: 'John',
70
+ phone: '1234567890',
71
+ field_we_dont_care_about: 'value_we_dont_care_about'
72
+ },
73
+ states: [{
74
+ id: 1,
75
+ name: 'New York',
76
+ code: 'NY',
77
+ field_we_dont_care_about: 'value_we_dont_care_about'
78
+ }]
79
+ }
80
+ ```
81
+
82
+ To limit our results to only return the fields we care about, we specify the
83
+ `select` query string parameter for the corresponding fields in the JSON
84
+ document.
85
+
86
+ In this case, we want to select `name` and `phone` from the `provider` key,
87
+ so we would add the parameters `select=provider.name,provider.phone`.
88
+ We also want the `name` and `code` from the `states` key, so we would
89
+ add the parameters `select=states.name,staes.code`. The id field of
90
+ each document is always returned whether or not it is requested.
91
+
92
+ Our final request would be `GET /providers/12345?select=provider.name,provider.phone,states.name,states.code`
93
+
94
+ The response would be
95
+
96
+ ```
97
+ {
98
+ provider: {
99
+ id: 1,
100
+ name: 'John',
101
+ phone: '1234567890'
102
+ },
103
+ states: [{
104
+ id: 1,
105
+ name: 'New York',
106
+ code: 'NY'
107
+ }]
108
+ }
109
+ ```
110
+
111
+
112
+
113
+ OpenAPI spec version: 1.0.0
114
+
115
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
116
+
117
+ Licensed under the Apache License, Version 2.0 (the "License");
118
+ you may not use this file except in compliance with the License.
119
+ You may obtain a copy of the License at
120
+
121
+ http://www.apache.org/licenses/LICENSE-2.0
122
+
123
+ Unless required by applicable law or agreed to in writing, software
124
+ distributed under the License is distributed on an "AS IS" BASIS,
125
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
126
+ See the License for the specific language governing permissions and
127
+ limitations under the License.
128
+
129
+ =end
130
+
131
+ require 'spec_helper'
132
+ require 'json'
133
+ require 'date'
134
+
135
+ # Unit tests for VericredClient::ServiceArea
136
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
137
+ # Please update as you see appropriate
138
+ describe 'ServiceArea' do
139
+ before do
140
+ # run before each test
141
+ @instance = VericredClient::ServiceArea.new
142
+ end
143
+
144
+ after do
145
+ # run after each test
146
+ end
147
+
148
+ describe 'test an instance of ServiceArea' do
149
+ it 'should create an instact of ServiceArea' do
150
+ expect(@instance).to be_instance_of(VericredClient::ServiceArea)
151
+ end
152
+ end
153
+ describe 'test attribute "id"' do
154
+ it 'should work' do
155
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
156
+ end
157
+ end
158
+
159
+ describe 'test attribute "issuer_id"' do
160
+ it 'should work' do
161
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
162
+ end
163
+ end
164
+
165
+ describe 'test attribute "name"' do
166
+ it 'should work' do
167
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
168
+ end
169
+ end
170
+
171
+ end
172
+
@@ -132,31 +132,31 @@ require 'spec_helper'
132
132
  require 'json'
133
133
  require 'date'
134
134
 
135
- # Unit tests for VericredClient::PlanZipCounty
135
+ # Unit tests for VericredClient::ServiceAreaZipCounty
136
136
  # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
137
137
  # Please update as you see appropriate
138
- describe 'PlanZipCounty' do
138
+ describe 'ServiceAreaZipCounty' do
139
139
  before do
140
140
  # run before each test
141
- @instance = VericredClient::PlanZipCounty.new
141
+ @instance = VericredClient::ServiceAreaZipCounty.new
142
142
  end
143
143
 
144
144
  after do
145
145
  # run after each test
146
146
  end
147
147
 
148
- describe 'test an instance of PlanZipCounty' do
149
- it 'should create an instact of PlanZipCounty' do
150
- expect(@instance).to be_instance_of(VericredClient::PlanZipCounty)
148
+ describe 'test an instance of ServiceAreaZipCounty' do
149
+ it 'should create an instact of ServiceAreaZipCounty' do
150
+ expect(@instance).to be_instance_of(VericredClient::ServiceAreaZipCounty)
151
151
  end
152
152
  end
153
- describe 'test attribute "plan_id"' do
153
+ describe 'test attribute "county_id"' do
154
154
  it 'should work' do
155
155
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
156
156
  end
157
157
  end
158
158
 
159
- describe 'test attribute "county_id"' do
159
+ describe 'test attribute "service_area_id"' do
160
160
  it 'should work' do
161
161
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
162
162
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: vericred_client
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.8
4
+ version: 0.0.9
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vericred Inc.
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2016-06-28 00:00:00.000000000 Z
11
+ date: 2016-08-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -220,7 +220,7 @@ files:
220
220
  - docs/PlanCountyBulk.md
221
221
  - docs/PlanSearchResponse.md
222
222
  - docs/PlanSearchResult.md
223
- - docs/PlanZipCounty.md
223
+ - docs/PlanShowResponse.md
224
224
  - docs/PlansApi.md
225
225
  - docs/Pricing.md
226
226
  - docs/Provider.md
@@ -230,8 +230,11 @@ files:
230
230
  - docs/RatingArea.md
231
231
  - docs/RequestPlanFind.md
232
232
  - docs/RequestPlanFindApplicant.md
233
+ - docs/RequestPlanFindDrugPackage.md
233
234
  - docs/RequestPlanFindProvider.md
234
235
  - docs/RequestProvidersSearch.md
236
+ - docs/ServiceArea.md
237
+ - docs/ServiceAreaZipCounty.md
235
238
  - docs/State.md
236
239
  - docs/ZipCode.md
237
240
  - docs/ZipCountiesApi.md
@@ -268,7 +271,7 @@ files:
268
271
  - lib/vericred_client/models/plan_county_bulk.rb
269
272
  - lib/vericred_client/models/plan_search_response.rb
270
273
  - lib/vericred_client/models/plan_search_result.rb
271
- - lib/vericred_client/models/plan_zip_county.rb
274
+ - lib/vericred_client/models/plan_show_response.rb
272
275
  - lib/vericred_client/models/pricing.rb
273
276
  - lib/vericred_client/models/provider.rb
274
277
  - lib/vericred_client/models/provider_show_response.rb
@@ -276,8 +279,11 @@ files:
276
279
  - lib/vericred_client/models/rating_area.rb
277
280
  - lib/vericred_client/models/request_plan_find.rb
278
281
  - lib/vericred_client/models/request_plan_find_applicant.rb
282
+ - lib/vericred_client/models/request_plan_find_drug_package.rb
279
283
  - lib/vericred_client/models/request_plan_find_provider.rb
280
284
  - lib/vericred_client/models/request_providers_search.rb
285
+ - lib/vericred_client/models/service_area.rb
286
+ - lib/vericred_client/models/service_area_zip_county.rb
281
287
  - lib/vericred_client/models/state.rb
282
288
  - lib/vericred_client/models/zip_code.rb
283
289
  - lib/vericred_client/models/zip_counties_response.rb
@@ -310,17 +316,20 @@ files:
310
316
  - spec/models/plan_county_spec.rb
311
317
  - spec/models/plan_search_response_spec.rb
312
318
  - spec/models/plan_search_result_spec.rb
319
+ - spec/models/plan_show_response_spec.rb
313
320
  - spec/models/plan_spec.rb
314
- - spec/models/plan_zip_county_spec.rb
315
321
  - spec/models/pricing_spec.rb
316
322
  - spec/models/provider_show_response_spec.rb
317
323
  - spec/models/provider_spec.rb
318
324
  - spec/models/providers_search_response_spec.rb
319
325
  - spec/models/rating_area_spec.rb
320
326
  - spec/models/request_plan_find_applicant_spec.rb
327
+ - spec/models/request_plan_find_drug_package_spec.rb
321
328
  - spec/models/request_plan_find_provider_spec.rb
322
329
  - spec/models/request_plan_find_spec.rb
323
330
  - spec/models/request_providers_search_spec.rb
331
+ - spec/models/service_area_spec.rb
332
+ - spec/models/service_area_zip_county_spec.rb
324
333
  - spec/models/state_spec.rb
325
334
  - spec/models/zip_code_spec.rb
326
335
  - spec/models/zip_counties_response_spec.rb
@@ -379,17 +388,20 @@ test_files:
379
388
  - spec/models/plan_county_spec.rb
380
389
  - spec/models/plan_search_response_spec.rb
381
390
  - spec/models/plan_search_result_spec.rb
391
+ - spec/models/plan_show_response_spec.rb
382
392
  - spec/models/plan_spec.rb
383
- - spec/models/plan_zip_county_spec.rb
384
393
  - spec/models/pricing_spec.rb
385
394
  - spec/models/provider_show_response_spec.rb
386
395
  - spec/models/provider_spec.rb
387
396
  - spec/models/providers_search_response_spec.rb
388
397
  - spec/models/rating_area_spec.rb
389
398
  - spec/models/request_plan_find_applicant_spec.rb
399
+ - spec/models/request_plan_find_drug_package_spec.rb
390
400
  - spec/models/request_plan_find_provider_spec.rb
391
401
  - spec/models/request_plan_find_spec.rb
392
402
  - spec/models/request_providers_search_spec.rb
403
+ - spec/models/service_area_spec.rb
404
+ - spec/models/service_area_zip_county_spec.rb
393
405
  - spec/models/state_spec.rb
394
406
  - spec/models/zip_code_spec.rb
395
407
  - spec/models/zip_counties_response_spec.rb
@@ -1,10 +0,0 @@
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
-