vericred_client 0.0.7 → 0.0.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +201 -0
- data/README.md +9 -10
- data/docs/DrugsApi.md +7 -9
- data/docs/NetworksApi.md +4 -6
- data/docs/PlansApi.md +4 -72
- data/docs/ProvidersApi.md +7 -20
- data/docs/RequestProvidersSearch.md +1 -3
- data/docs/ZipCountiesApi.md +3 -3
- data/git_push.sh +67 -0
- data/lib/vericred_client/api/drugs_api.rb +17 -11
- data/lib/vericred_client/api/networks_api.rb +18 -12
- data/lib/vericred_client/api/plans_api.rb +15 -141
- data/lib/vericred_client/api/providers_api.rb +16 -32
- data/lib/vericred_client/api/zip_counties_api.rb +14 -4
- data/lib/vericred_client/api_client.rb +13 -3
- data/lib/vericred_client/api_error.rb +13 -3
- data/lib/vericred_client/configuration.rb +130 -0
- data/lib/vericred_client/models/applicant.rb +20 -6
- data/lib/vericred_client/models/base.rb +20 -6
- data/lib/vericred_client/models/carrier.rb +20 -6
- data/lib/vericred_client/models/carrier_subsidiary.rb +20 -6
- data/lib/vericred_client/models/county.rb +20 -6
- data/lib/vericred_client/models/county_bulk.rb +20 -6
- data/lib/vericred_client/models/drug.rb +20 -6
- data/lib/vericred_client/models/drug_coverage.rb +20 -6
- data/lib/vericred_client/models/drug_coverage_response.rb +20 -6
- data/lib/vericred_client/models/drug_package.rb +20 -6
- data/lib/vericred_client/models/drug_search_response.rb +20 -6
- data/lib/vericred_client/models/meta.rb +20 -6
- data/lib/vericred_client/models/network.rb +20 -6
- data/lib/vericred_client/models/network_search_response.rb +20 -6
- data/lib/vericred_client/models/plan.rb +20 -6
- data/lib/vericred_client/models/plan_county.rb +20 -6
- data/lib/vericred_client/models/plan_county_bulk.rb +20 -6
- data/lib/vericred_client/models/plan_search_response.rb +20 -6
- data/lib/vericred_client/models/plan_search_result.rb +20 -6
- data/lib/vericred_client/models/plan_zip_county.rb +20 -6
- data/lib/vericred_client/models/pricing.rb +20 -6
- data/lib/vericred_client/models/provider.rb +20 -6
- data/lib/vericred_client/models/provider_show_response.rb +20 -6
- data/lib/vericred_client/models/providers_search_response.rb +20 -6
- data/lib/vericred_client/models/rating_area.rb +20 -6
- data/lib/vericred_client/models/request_plan_find.rb +20 -6
- data/lib/vericred_client/models/request_plan_find_applicant.rb +20 -6
- data/lib/vericred_client/models/request_plan_find_provider.rb +20 -6
- data/lib/vericred_client/models/request_providers_search.rb +21 -9
- data/lib/vericred_client/models/state.rb +20 -6
- data/lib/vericred_client/models/zip_code.rb +20 -6
- data/lib/vericred_client/models/zip_counties_response.rb +20 -6
- data/lib/vericred_client/models/zip_county.rb +20 -6
- data/lib/vericred_client/models/zip_county_bulk.rb +20 -6
- data/lib/vericred_client/models/zip_county_response.rb +20 -6
- data/lib/vericred_client/version.rb +14 -4
- data/lib/vericred_client.rb +13 -3
- data/spec/api/drugs_api_spec.rb +17 -17
- data/spec/api/networks_api_spec.rb +16 -12
- data/spec/api/plans_api_spec.rb +16 -78
- data/spec/api/providers_api_spec.rb +17 -28
- data/spec/api/zip_counties_api_spec.rb +15 -9
- data/spec/api_client_spec.rb +403 -0
- data/spec/configuration_spec.rb +155 -0
- data/spec/models/applicant_spec.rb +196 -0
- data/spec/models/base_spec.rb +160 -0
- data/spec/models/carrier_spec.rb +172 -0
- data/spec/models/carrier_subsidiary_spec.rb +172 -0
- data/spec/models/county_bulk_spec.rb +172 -0
- data/spec/models/county_spec.rb +196 -0
- data/spec/models/drug_coverage_response_spec.rb +178 -0
- data/spec/models/drug_coverage_spec.rb +190 -0
- data/spec/models/drug_package_spec.rb +166 -0
- data/spec/models/drug_search_response_spec.rb +172 -0
- data/spec/models/drug_spec.rb +178 -0
- data/spec/models/meta_spec.rb +160 -0
- data/spec/models/network_search_response_spec.rb +166 -0
- data/spec/models/network_spec.rb +166 -0
- data/spec/models/plan_county_bulk_spec.rb +166 -0
- data/spec/models/plan_county_spec.rb +166 -0
- data/spec/models/plan_search_response_spec.rb +172 -0
- data/spec/models/plan_search_result_spec.rb +562 -0
- data/spec/models/plan_spec.rb +544 -0
- data/spec/models/plan_zip_county_spec.rb +172 -0
- data/spec/models/pricing_spec.rb +220 -0
- data/spec/models/provider_show_response_spec.rb +160 -0
- data/spec/models/provider_spec.rb +322 -0
- data/spec/models/providers_search_response_spec.rb +172 -0
- data/spec/models/rating_area_spec.rb +166 -0
- data/spec/models/request_plan_find_applicant_spec.rb +160 -0
- data/spec/models/request_plan_find_provider_spec.rb +160 -0
- data/spec/models/request_plan_find_spec.rb +226 -0
- data/spec/models/request_providers_search_spec.rb +202 -0
- data/spec/models/state_spec.rb +202 -0
- data/spec/models/zip_code_spec.rb +166 -0
- data/spec/models/zip_counties_response_spec.rb +178 -0
- data/spec/models/zip_county_bulk_spec.rb +178 -0
- data/spec/models/zip_county_response_spec.rb +178 -0
- data/spec/models/zip_county_spec.rb +172 -0
- data/spec/spec_helper.rb +229 -0
- data/vericred_client.gemspec +131 -0
- metadata +80 -2
@@ -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::PlanZipCounty
|
136
|
+
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
137
|
+
# Please update as you see appropriate
|
138
|
+
describe 'PlanZipCounty' do
|
139
|
+
before do
|
140
|
+
# run before each test
|
141
|
+
@instance = VericredClient::PlanZipCounty.new
|
142
|
+
end
|
143
|
+
|
144
|
+
after do
|
145
|
+
# run after each test
|
146
|
+
end
|
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)
|
151
|
+
end
|
152
|
+
end
|
153
|
+
describe 'test attribute "plan_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 "county_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 "zip_code_id"' 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
|
+
|
@@ -0,0 +1,220 @@
|
|
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::Pricing
|
136
|
+
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
137
|
+
# Please update as you see appropriate
|
138
|
+
describe 'Pricing' do
|
139
|
+
before do
|
140
|
+
# run before each test
|
141
|
+
@instance = VericredClient::Pricing.new
|
142
|
+
end
|
143
|
+
|
144
|
+
after do
|
145
|
+
# run after each test
|
146
|
+
end
|
147
|
+
|
148
|
+
describe 'test an instance of Pricing' do
|
149
|
+
it 'should create an instact of Pricing' do
|
150
|
+
expect(@instance).to be_instance_of(VericredClient::Pricing)
|
151
|
+
end
|
152
|
+
end
|
153
|
+
describe 'test attribute "age"' 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 "effective_date"' 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 "expiration_date"' 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
|
+
describe 'test attribute "plan_id"' do
|
172
|
+
it 'should work' do
|
173
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
174
|
+
end
|
175
|
+
end
|
176
|
+
|
177
|
+
describe 'test attribute "premium_child_only"' do
|
178
|
+
it 'should work' do
|
179
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
180
|
+
end
|
181
|
+
end
|
182
|
+
|
183
|
+
describe 'test attribute "premium_family"' do
|
184
|
+
it 'should work' do
|
185
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
186
|
+
end
|
187
|
+
end
|
188
|
+
|
189
|
+
describe 'test attribute "premium_single"' 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
|
+
|
195
|
+
describe 'test attribute "premium_single_and_children"' do
|
196
|
+
it 'should work' do
|
197
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
198
|
+
end
|
199
|
+
end
|
200
|
+
|
201
|
+
describe 'test attribute "premium_single_and_spouse"' do
|
202
|
+
it 'should work' do
|
203
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
204
|
+
end
|
205
|
+
end
|
206
|
+
|
207
|
+
describe 'test attribute "premium_single_smoker"' do
|
208
|
+
it 'should work' do
|
209
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
210
|
+
end
|
211
|
+
end
|
212
|
+
|
213
|
+
describe 'test attribute "rating_area_id"' do
|
214
|
+
it 'should work' do
|
215
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
216
|
+
end
|
217
|
+
end
|
218
|
+
|
219
|
+
end
|
220
|
+
|
@@ -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::ProviderShowResponse
|
136
|
+
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
137
|
+
# Please update as you see appropriate
|
138
|
+
describe 'ProviderShowResponse' do
|
139
|
+
before do
|
140
|
+
# run before each test
|
141
|
+
@instance = VericredClient::ProviderShowResponse.new
|
142
|
+
end
|
143
|
+
|
144
|
+
after do
|
145
|
+
# run after each test
|
146
|
+
end
|
147
|
+
|
148
|
+
describe 'test an instance of ProviderShowResponse' do
|
149
|
+
it 'should create an instact of ProviderShowResponse' do
|
150
|
+
expect(@instance).to be_instance_of(VericredClient::ProviderShowResponse)
|
151
|
+
end
|
152
|
+
end
|
153
|
+
describe 'test attribute "provider"' 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
|
+
|