vericred_client 0.0.21 → 0.0.23

Sign up to get free protection for your applications and to get access to all the features.
Files changed (270) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +201 -0
  3. data/README.md +204 -8
  4. data/docs/CarrierGroupsApi.md +3 -3
  5. data/docs/CarrierVerificationPlansApi.md +1 -1
  6. data/docs/CarriersApi.md +3 -3
  7. data/docs/DentalPlansApi.md +4 -4
  8. data/docs/DrugCoveragesApi.md +4 -4
  9. data/docs/DrugPackagesApi.md +2 -2
  10. data/docs/DrugsApi.md +2 -2
  11. data/docs/EmbargoesApi.md +3 -3
  12. data/docs/FormulariesApi.md +3 -3
  13. data/docs/IssuersApi.md +3 -3
  14. data/docs/MedicalPlansApi.md +3 -3
  15. data/docs/NetworkSizesApi.md +2 -2
  16. data/docs/NetworksApi.md +1 -1
  17. data/docs/PlansApi.md +3 -3
  18. data/docs/ProviderNotificationSubscriptionsApi.md +2 -2
  19. data/docs/ProvidersApi.md +1 -1
  20. data/docs/RatesApi.md +3 -3
  21. data/docs/VisionPlansApi.md +4 -4
  22. data/docs/ZipCountiesApi.md +2 -2
  23. data/lib/vericred_client/api/carrier_groups_api.rb +226 -17
  24. data/lib/vericred_client/api/carrier_verification_plans_api.rb +217 -8
  25. data/lib/vericred_client/api/carriers_api.rb +226 -17
  26. data/lib/vericred_client/api/dental_plans_api.rb +234 -23
  27. data/lib/vericred_client/api/drug_coverages_api.rb +221 -12
  28. data/lib/vericred_client/api/drug_packages_api.rb +218 -11
  29. data/lib/vericred_client/api/drugs_api.rb +217 -8
  30. data/lib/vericred_client/api/embargoes_api.rb +226 -17
  31. data/lib/vericred_client/api/formularies_api.rb +216 -5
  32. data/lib/vericred_client/api/issuers_api.rb +226 -17
  33. data/lib/vericred_client/api/medical_plans_api.rb +236 -21
  34. data/lib/vericred_client/api/network_sizes_api.rb +225 -14
  35. data/lib/vericred_client/api/networks_api.rb +234 -23
  36. data/lib/vericred_client/api/plans_api.rb +244 -27
  37. data/lib/vericred_client/api/provider_notification_subscriptions_api.rb +233 -12
  38. data/lib/vericred_client/api/providers_api.rb +246 -25
  39. data/lib/vericred_client/api/rates_api.rb +226 -17
  40. data/lib/vericred_client/api/vision_plans_api.rb +234 -23
  41. data/lib/vericred_client/api/zip_counties_api.rb +229 -10
  42. data/lib/vericred_client/api_client.rb +257 -69
  43. data/lib/vericred_client/api_error.rb +214 -9
  44. data/lib/vericred_client/configuration.rb +209 -8
  45. data/lib/vericred_client/models/aca_plan.rb +211 -4
  46. data/lib/vericred_client/models/aca_plan2018.rb +211 -4
  47. data/lib/vericred_client/models/aca_plan2018_search_response.rb +211 -4
  48. data/lib/vericred_client/models/aca_plan2018_search_result.rb +211 -4
  49. data/lib/vericred_client/models/aca_plan2018_show_response.rb +211 -4
  50. data/lib/vericred_client/models/aca_plan_pre2018.rb +211 -4
  51. data/lib/vericred_client/models/aca_plan_pre2018_search_response.rb +211 -4
  52. data/lib/vericred_client/models/aca_plan_pre2018_search_result.rb +211 -4
  53. data/lib/vericred_client/models/aca_plan_pre2018_show_response.rb +211 -4
  54. data/lib/vericred_client/models/base.rb +211 -4
  55. data/lib/vericred_client/models/base_plan_search_response.rb +211 -4
  56. data/lib/vericred_client/models/carrier.rb +211 -4
  57. data/lib/vericred_client/models/carrier_group_request.rb +211 -4
  58. data/lib/vericred_client/models/carrier_request.rb +211 -4
  59. data/lib/vericred_client/models/carrier_subsidiary.rb +211 -4
  60. data/lib/vericred_client/models/county.rb +211 -4
  61. data/lib/vericred_client/models/county_bulk.rb +211 -4
  62. data/lib/vericred_client/models/dental_plan.rb +211 -4
  63. data/lib/vericred_client/models/dental_plan_benefits.rb +211 -4
  64. data/lib/vericred_client/models/dental_plan_search_applicant.rb +211 -4
  65. data/lib/vericred_client/models/dental_plan_search_request.rb +211 -4
  66. data/lib/vericred_client/models/dental_plan_search_response.rb +211 -4
  67. data/lib/vericred_client/models/dental_plan_show_response.rb +211 -4
  68. data/lib/vericred_client/models/dental_plan_update.rb +211 -4
  69. data/lib/vericred_client/models/dental_plan_update_request.rb +211 -4
  70. data/lib/vericred_client/models/drug.rb +211 -4
  71. data/lib/vericred_client/models/drug_coverage.rb +211 -4
  72. data/lib/vericred_client/models/drug_coverage_response.rb +211 -4
  73. data/lib/vericred_client/models/drug_package.rb +211 -4
  74. data/lib/vericred_client/models/drug_search_response.rb +211 -4
  75. data/lib/vericred_client/models/embargo_request.rb +211 -4
  76. data/lib/vericred_client/models/formulary.rb +211 -4
  77. data/lib/vericred_client/models/formulary_drug_package_response.rb +211 -4
  78. data/lib/vericred_client/models/formulary_response.rb +211 -4
  79. data/lib/vericred_client/models/issuer_request.rb +211 -4
  80. data/lib/vericred_client/models/medical_plan_benefits.rb +211 -4
  81. data/lib/vericred_client/models/medical_plan_update.rb +211 -4
  82. data/lib/vericred_client/models/medical_plan_update_request.rb +211 -4
  83. data/lib/vericred_client/models/meta.rb +211 -4
  84. data/lib/vericred_client/models/meta_plan_search_response.rb +211 -4
  85. data/lib/vericred_client/models/network.rb +211 -4
  86. data/lib/vericred_client/models/network_comparison.rb +211 -4
  87. data/lib/vericred_client/models/network_comparison_request.rb +211 -4
  88. data/lib/vericred_client/models/network_comparison_response.rb +211 -4
  89. data/lib/vericred_client/models/network_details.rb +211 -4
  90. data/lib/vericred_client/models/network_details_response.rb +211 -4
  91. data/lib/vericred_client/models/network_search_response.rb +211 -4
  92. data/lib/vericred_client/models/network_size.rb +211 -4
  93. data/lib/vericred_client/models/notification_subscription.rb +211 -4
  94. data/lib/vericred_client/models/notification_subscription_response.rb +211 -4
  95. data/lib/vericred_client/models/plan.rb +211 -4
  96. data/lib/vericred_client/models/plan_county.rb +211 -4
  97. data/lib/vericred_client/models/plan_county_bulk.rb +211 -4
  98. data/lib/vericred_client/models/plan_deleted.rb +211 -4
  99. data/lib/vericred_client/models/plan_identifier.rb +211 -4
  100. data/lib/vericred_client/models/plan_medicare.rb +211 -4
  101. data/lib/vericred_client/models/plan_medicare_bulk.rb +211 -4
  102. data/lib/vericred_client/models/plan_pricing_medicare.rb +211 -4
  103. data/lib/vericred_client/models/plan_search_response.rb +211 -4
  104. data/lib/vericred_client/models/plan_show_response.rb +211 -4
  105. data/lib/vericred_client/models/provider.rb +211 -4
  106. data/lib/vericred_client/models/provider_details.rb +211 -4
  107. data/lib/vericred_client/models/provider_geocode.rb +211 -4
  108. data/lib/vericred_client/models/provider_network_event_notification.rb +211 -4
  109. data/lib/vericred_client/models/provider_show_response.rb +211 -4
  110. data/lib/vericred_client/models/providers_geocode_response.rb +211 -4
  111. data/lib/vericred_client/models/providers_search_response.rb +211 -4
  112. data/lib/vericred_client/models/rate_request.rb +211 -4
  113. data/lib/vericred_client/models/rate_search.rb +211 -4
  114. data/lib/vericred_client/models/rating_area.rb +211 -4
  115. data/lib/vericred_client/models/request_plan_find.rb +211 -4
  116. data/lib/vericred_client/models/request_plan_find_applicant.rb +211 -4
  117. data/lib/vericred_client/models/request_plan_find_carrier_verification.rb +211 -4
  118. data/lib/vericred_client/models/request_plan_find_drug_package.rb +211 -4
  119. data/lib/vericred_client/models/request_plan_find_provider.rb +211 -4
  120. data/lib/vericred_client/models/request_provider_notification_subscription.rb +211 -4
  121. data/lib/vericred_client/models/request_providers_search.rb +211 -4
  122. data/lib/vericred_client/models/request_rates_search.rb +211 -4
  123. data/lib/vericred_client/models/response_rates_search.rb +211 -4
  124. data/lib/vericred_client/models/rx_cui_identifier.rb +211 -4
  125. data/lib/vericred_client/models/rx_cui_identifier_search_response.rb +211 -4
  126. data/lib/vericred_client/models/service_area.rb +211 -4
  127. data/lib/vericred_client/models/service_area_zip_county.rb +211 -4
  128. data/lib/vericred_client/models/state.rb +211 -4
  129. data/lib/vericred_client/models/state_network_size_request.rb +211 -4
  130. data/lib/vericred_client/models/state_network_size_response.rb +211 -4
  131. data/lib/vericred_client/models/vision_plan.rb +211 -4
  132. data/lib/vericred_client/models/vision_plan_benefits.rb +211 -4
  133. data/lib/vericred_client/models/vision_plan_search_applicant.rb +211 -4
  134. data/lib/vericred_client/models/vision_plan_search_request.rb +211 -4
  135. data/lib/vericred_client/models/vision_plan_search_response.rb +211 -4
  136. data/lib/vericred_client/models/vision_plan_show_response.rb +211 -4
  137. data/lib/vericred_client/models/vision_plan_update.rb +211 -4
  138. data/lib/vericred_client/models/vision_plan_update_request.rb +211 -4
  139. data/lib/vericred_client/models/zip_code.rb +211 -4
  140. data/lib/vericred_client/models/zip_counties_response.rb +211 -4
  141. data/lib/vericred_client/models/zip_county.rb +211 -4
  142. data/lib/vericred_client/models/zip_county_bulk.rb +211 -4
  143. data/lib/vericred_client/models/zip_county_response.rb +211 -4
  144. data/lib/vericred_client/version.rb +210 -3
  145. data/lib/vericred_client.rb +209 -2
  146. data/spec/api/carrier_groups_api_spec.rb +210 -3
  147. data/spec/api/carrier_verification_plans_api_spec.rb +210 -3
  148. data/spec/api/carriers_api_spec.rb +210 -3
  149. data/spec/api/dental_plans_api_spec.rb +210 -3
  150. data/spec/api/drug_coverages_api_spec.rb +210 -3
  151. data/spec/api/drug_packages_api_spec.rb +210 -3
  152. data/spec/api/drugs_api_spec.rb +210 -3
  153. data/spec/api/embargoes_api_spec.rb +210 -3
  154. data/spec/api/formularies_api_spec.rb +210 -3
  155. data/spec/api/issuers_api_spec.rb +210 -3
  156. data/spec/api/medical_plans_api_spec.rb +210 -3
  157. data/spec/api/network_sizes_api_spec.rb +210 -3
  158. data/spec/api/networks_api_spec.rb +210 -3
  159. data/spec/api/plans_api_spec.rb +210 -3
  160. data/spec/api/provider_notification_subscriptions_api_spec.rb +210 -3
  161. data/spec/api/providers_api_spec.rb +210 -3
  162. data/spec/api/rates_api_spec.rb +210 -3
  163. data/spec/api/vision_plans_api_spec.rb +210 -3
  164. data/spec/api/zip_counties_api_spec.rb +210 -3
  165. data/spec/api_client_spec.rb +212 -26
  166. data/spec/configuration_spec.rb +212 -5
  167. data/spec/models/aca_plan2018_search_response_spec.rb +210 -3
  168. data/spec/models/aca_plan2018_search_result_spec.rb +210 -3
  169. data/spec/models/aca_plan2018_show_response_spec.rb +210 -3
  170. data/spec/models/aca_plan2018_spec.rb +210 -3
  171. data/spec/models/aca_plan_pre2018_search_response_spec.rb +210 -3
  172. data/spec/models/aca_plan_pre2018_search_result_spec.rb +210 -3
  173. data/spec/models/aca_plan_pre2018_show_response_spec.rb +210 -3
  174. data/spec/models/aca_plan_pre2018_spec.rb +210 -3
  175. data/spec/models/aca_plan_spec.rb +210 -3
  176. data/spec/models/base_plan_search_response_spec.rb +210 -3
  177. data/spec/models/base_spec.rb +210 -3
  178. data/spec/models/carrier_group_request_spec.rb +210 -3
  179. data/spec/models/carrier_request_spec.rb +210 -3
  180. data/spec/models/carrier_spec.rb +210 -3
  181. data/spec/models/carrier_subsidiary_spec.rb +210 -3
  182. data/spec/models/county_bulk_spec.rb +210 -3
  183. data/spec/models/county_spec.rb +210 -3
  184. data/spec/models/dental_plan_benefits_spec.rb +210 -3
  185. data/spec/models/dental_plan_search_applicant_spec.rb +210 -3
  186. data/spec/models/dental_plan_search_request_spec.rb +210 -3
  187. data/spec/models/dental_plan_search_response_spec.rb +210 -3
  188. data/spec/models/dental_plan_show_response_spec.rb +210 -3
  189. data/spec/models/dental_plan_spec.rb +210 -3
  190. data/spec/models/dental_plan_update_request_spec.rb +210 -3
  191. data/spec/models/dental_plan_update_spec.rb +210 -3
  192. data/spec/models/drug_coverage_response_spec.rb +210 -3
  193. data/spec/models/drug_coverage_spec.rb +210 -3
  194. data/spec/models/drug_package_spec.rb +210 -3
  195. data/spec/models/drug_search_response_spec.rb +210 -3
  196. data/spec/models/drug_spec.rb +210 -3
  197. data/spec/models/embargo_request_spec.rb +210 -3
  198. data/spec/models/formulary_drug_package_response_spec.rb +210 -3
  199. data/spec/models/formulary_response_spec.rb +210 -3
  200. data/spec/models/formulary_spec.rb +210 -3
  201. data/spec/models/issuer_request_spec.rb +210 -3
  202. data/spec/models/medical_plan_benefits_spec.rb +210 -3
  203. data/spec/models/medical_plan_update_request_spec.rb +210 -3
  204. data/spec/models/medical_plan_update_spec.rb +210 -3
  205. data/spec/models/meta_plan_search_response_spec.rb +210 -3
  206. data/spec/models/meta_spec.rb +210 -3
  207. data/spec/models/network_comparison_request_spec.rb +210 -3
  208. data/spec/models/network_comparison_response_spec.rb +210 -3
  209. data/spec/models/network_comparison_spec.rb +210 -3
  210. data/spec/models/network_details_response_spec.rb +210 -3
  211. data/spec/models/network_details_spec.rb +210 -3
  212. data/spec/models/network_search_response_spec.rb +210 -3
  213. data/spec/models/network_size_spec.rb +210 -3
  214. data/spec/models/network_spec.rb +210 -3
  215. data/spec/models/notification_subscription_response_spec.rb +210 -3
  216. data/spec/models/notification_subscription_spec.rb +210 -3
  217. data/spec/models/plan_county_bulk_spec.rb +210 -3
  218. data/spec/models/plan_county_spec.rb +210 -3
  219. data/spec/models/plan_deleted_spec.rb +210 -3
  220. data/spec/models/plan_identifier_spec.rb +210 -3
  221. data/spec/models/plan_medicare_bulk_spec.rb +210 -3
  222. data/spec/models/plan_medicare_spec.rb +210 -3
  223. data/spec/models/plan_pricing_medicare_spec.rb +210 -3
  224. data/spec/models/plan_search_response_spec.rb +210 -3
  225. data/spec/models/plan_show_response_spec.rb +210 -3
  226. data/spec/models/plan_spec.rb +210 -3
  227. data/spec/models/provider_details_spec.rb +210 -3
  228. data/spec/models/provider_geocode_spec.rb +210 -3
  229. data/spec/models/provider_network_event_notification_spec.rb +210 -3
  230. data/spec/models/provider_show_response_spec.rb +210 -3
  231. data/spec/models/provider_spec.rb +210 -3
  232. data/spec/models/providers_geocode_response_spec.rb +210 -3
  233. data/spec/models/providers_search_response_spec.rb +210 -3
  234. data/spec/models/rate_request_spec.rb +210 -3
  235. data/spec/models/rate_search_spec.rb +210 -3
  236. data/spec/models/rating_area_spec.rb +210 -3
  237. data/spec/models/request_plan_find_applicant_spec.rb +210 -3
  238. data/spec/models/request_plan_find_carrier_verification_spec.rb +210 -3
  239. data/spec/models/request_plan_find_drug_package_spec.rb +210 -3
  240. data/spec/models/request_plan_find_provider_spec.rb +210 -3
  241. data/spec/models/request_plan_find_spec.rb +210 -3
  242. data/spec/models/request_provider_notification_subscription_spec.rb +210 -3
  243. data/spec/models/request_providers_search_spec.rb +210 -3
  244. data/spec/models/request_rates_search_spec.rb +210 -3
  245. data/spec/models/response_rates_search_spec.rb +210 -3
  246. data/spec/models/rx_cui_identifier_search_response_spec.rb +210 -3
  247. data/spec/models/rx_cui_identifier_spec.rb +210 -3
  248. data/spec/models/service_area_spec.rb +210 -3
  249. data/spec/models/service_area_zip_county_spec.rb +210 -3
  250. data/spec/models/state_network_size_request_spec.rb +210 -3
  251. data/spec/models/state_network_size_response_spec.rb +210 -3
  252. data/spec/models/state_spec.rb +210 -3
  253. data/spec/models/vision_plan_benefits_spec.rb +210 -3
  254. data/spec/models/vision_plan_search_applicant_spec.rb +210 -3
  255. data/spec/models/vision_plan_search_request_spec.rb +210 -3
  256. data/spec/models/vision_plan_search_response_spec.rb +210 -3
  257. data/spec/models/vision_plan_show_response_spec.rb +210 -3
  258. data/spec/models/vision_plan_spec.rb +210 -3
  259. data/spec/models/vision_plan_update_request_spec.rb +210 -3
  260. data/spec/models/vision_plan_update_spec.rb +210 -3
  261. data/spec/models/zip_code_spec.rb +210 -3
  262. data/spec/models/zip_counties_response_spec.rb +210 -3
  263. data/spec/models/zip_county_bulk_spec.rb +210 -3
  264. data/spec/models/zip_county_response_spec.rb +210 -3
  265. data/spec/models/zip_county_spec.rb +210 -3
  266. data/spec/spec_helper.rb +209 -2
  267. data/vericred_client.gemspec +213 -6
  268. metadata +16 -23
  269. data/Gemfile +0 -7
  270. data/Rakefile +0 -8
@@ -1,12 +1,219 @@
1
1
  =begin
2
2
  #Vericred API
3
3
 
4
- #Vericred's API allows you to search for Health Plans that a specific doctor accepts. ## Getting Started Visit our [Developer Portal](https://developers.vericred.com) to create an account. Once you have created an account, you can create one Application for Production and another for our Sandbox (select the appropriate Plan when you create the Application). ## SDKs Our API follows standard REST conventions, so you can use any HTTP client to integrate with us. You will likely find it easier to use one of our [autogenerated SDKs](https://github.com/vericred/?query=vericred-), which we make available for several common programming languages. ## Authentication To authenticate, pass the API Key you created in the Developer Portal as a `Vericred-Api-Key` header. `curl -H 'Vericred-Api-Key: YOUR_KEY' \"https://api.vericred.com/providers?search_term=Foo&zip_code=11215\"` ## Versioning Vericred's API default to the latest version. However, if you need a specific version, you can request it with an `Accept-Version` header. The current version is `v3`. Previous versions are `v1` and `v2`. `curl -H 'Vericred-Api-Key: YOUR_KEY' -H 'Accept-Version: v2' \"https://api.vericred.com/providers?search_term=Foo&zip_code=11215\"` ## Pagination Endpoints that accept `page` and `per_page` parameters are paginated. They expose four additional fields that contain data about your position in the response, namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988). For example, to display 5 results per page and view the second page of a `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`. ## Sideloading When we return multiple levels of an object graph (e.g. `Provider`s and their `State`s we sideload the associated data. In this example, we would provide an Array of `State`s and a `state_id` for each provider. This is done primarily to reduce the payload size since many of the `Provider`s will share a `State` ``` { providers: [{ id: 1, state_id: 1}, { id: 2, state_id: 1 }], states: [{ id: 1, code: 'NY' }] } ``` If you need the second level of the object graph, you can just match the corresponding id. ## Selecting specific data All endpoints allow you to specify which fields you would like to return. This allows you to limit the response to contain only the data you need. For example, let's take a request that returns the following JSON by default ``` { provider: { id: 1, name: 'John', phone: '1234567890', field_we_dont_care_about: 'value_we_dont_care_about' }, states: [{ id: 1, name: 'New York', code: 'NY', field_we_dont_care_about: 'value_we_dont_care_about' }] } ``` To limit our results to only return the fields we care about, we specify the `select` query string parameter for the corresponding fields in the JSON document. In this case, we want to select `name` and `phone` from the `provider` key, so we would add the parameters `select=provider.name,provider.phone`. We also want the `name` and `code` from the `states` key, so we would add the parameters `select=states.name,states.code`. The id field of each document is always returned whether or not it is requested. Our final request would be `GET /providers/12345?select=provider.name,provider.phone,states.name,states.code` The response would be ``` { provider: { id: 1, name: 'John', phone: '1234567890' }, states: [{ id: 1, name: 'New York', code: 'NY' }] } ``` ## Benefits summary format Benefit cost-share strings are formatted to capture: * Network tiers * Compound or conditional cost-share * Limits on the cost-share * Benefit-specific maximum out-of-pocket costs **Example #1** As an example, we would represent [this Summary of Benefits & Coverage](https://s3.amazonaws.com/vericred-data/SBC/2017/33602TX0780032.pdf) as: * **Hospital stay facility fees**: - Network Provider: `$400 copay/admit plus 20% coinsurance` - Out-of-Network Provider: `$1,500 copay/admit plus 50% coinsurance` - Vericred's format for this benefit: `In-Network: $400 before deductible then 20% after deductible / Out-of-Network: $1,500 before deductible then 50% after deductible` * **Rehabilitation services:** - Network Provider: `20% coinsurance` - Out-of-Network Provider: `50% coinsurance` - Limitations & Exceptions: `35 visit maximum per benefit period combined with Chiropractic care.` - Vericred's format for this benefit: `In-Network: 20% after deductible / Out-of-Network: 50% after deductible | limit: 35 visit(s) per Benefit Period` **Example #2** In [this other Summary of Benefits & Coverage](https://s3.amazonaws.com/vericred-data/SBC/2017/40733CA0110568.pdf), the **specialty_drugs** cost-share has a maximum out-of-pocket for in-network pharmacies. * **Specialty drugs:** - Network Provider: `40% coinsurance up to a $500 maximum for up to a 30 day supply` - Out-of-Network Provider `Not covered` - Vericred's format for this benefit: `In-Network: 40% after deductible, up to $500 per script / Out-of-Network: 100%` **BNF** Here's a description of the benefits summary string, represented as a context-free grammar: ``` root ::= coverage coverage ::= (simple_coverage | tiered_coverage) (space pipe space coverage_modifier)? tiered_coverage ::= tier (space slash space tier)* tier ::= tier_name colon space (tier_coverage | not_applicable) tier_coverage ::= simple_coverage (space (then | or | and) space simple_coverage)* tier_limitation? simple_coverage ::= (pre_coverage_limitation space)? coverage_amount (space post_coverage_limitation)? (comma? space coverage_condition)? coverage_modifier ::= limit_condition colon space (((simple_coverage | simple_limitation) (semicolon space see_carrier_documentation)?) | see_carrier_documentation | waived_if_admitted | shared_across_tiers) waived_if_admitted ::= (\"copay\" space)? \"waived if admitted\" simple_limitation ::= pre_coverage_limitation space \"copay applies\" tier_name ::= \"In-Network-Tier-2\" | \"Out-of-Network\" | \"In-Network\" limit_condition ::= \"limit\" | \"condition\" tier_limitation ::= comma space \"up to\" space (currency | (integer space time_unit plural?)) (space post_coverage_limitation)? coverage_amount ::= currency | unlimited | included | unknown | percentage | (digits space (treatment_unit | time_unit) plural?) pre_coverage_limitation ::= first space digits space time_unit plural? post_coverage_limitation ::= (((then space currency) | \"per condition\") space)? \"per\" space (treatment_unit | (integer space time_unit) | time_unit) plural? coverage_condition ::= (\"before deductible\" | \"after deductible\" | \"penalty\" | allowance | \"in-state\" | \"out-of-state\") (space allowance)? allowance ::= upto_allowance | after_allowance upto_allowance ::= \"up to\" space (currency space)? \"allowance\" after_allowance ::= \"after\" space (currency space)? \"allowance\" see_carrier_documentation ::= \"see carrier documentation for more information\" shared_across_tiers ::= \"shared across all tiers\" unknown ::= \"unknown\" unlimited ::= /[uU]nlimited/ included ::= /[iI]ncluded in [mM]edical/ time_unit ::= /[hH]our/ | (((/[cC]alendar/ | /[cC]ontract/) space)? /[yY]ear/) | /[mM]onth/ | /[dD]ay/ | /[wW]eek/ | /[vV]isit/ | /[lL]ifetime/ | ((((/[bB]enefit/ plural?) | /[eE]ligibility/) space)? /[pP]eriod/) treatment_unit ::= /[pP]erson/ | /[gG]roup/ | /[cC]ondition/ | /[sS]cript/ | /[vV]isit/ | /[eE]xam/ | /[iI]tem/ | /[sS]tay/ | /[tT]reatment/ | /[aA]dmission/ | /[eE]pisode/ comma ::= \",\" colon ::= \":\" semicolon ::= \";\" pipe ::= \"|\" slash ::= \"/\" plural ::= \"(s)\" | \"s\" then ::= \"then\" | (\",\" space) | space or ::= \"or\" and ::= \"and\" not_applicable ::= \"Not Applicable\" | \"N/A\" | \"NA\" first ::= \"first\" currency ::= \"$\" number percentage ::= number \"%\" number ::= float | integer float ::= digits \".\" digits integer ::= /[0-9]/+ (comma_int | under_int)* comma_int ::= (\",\" /[0-9]/*3) !\"_\" under_int ::= (\"_\" /[0-9]/*3) !\",\" digits ::= /[0-9]/+ (\"_\" /[0-9]/+)* space ::= /[ \\t]/+ ```
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://developers.vericred.com) 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
+ ## SDKs
17
+
18
+ Our API follows standard REST conventions, so you can use any HTTP client
19
+ to integrate with us. You will likely find it easier to use one of our
20
+ [autogenerated SDKs](https://github.com/vericred/?query=vericred-),
21
+ which we make available for several common programming languages.
22
+
23
+ ## Authentication
24
+
25
+ To authenticate, pass the API Key you created in the Developer Portal as
26
+ a `Vericred-Api-Key` header.
27
+
28
+ `curl -H 'Vericred-Api-Key: YOUR_KEY' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
29
+
30
+ ## Versioning
31
+
32
+ Vericred's API default to the latest version. However, if you need a specific
33
+ version, you can request it with an `Accept-Version` header.
34
+
35
+ The current version is `v3`. Previous versions are `v1` and `v2`.
36
+
37
+ `curl -H 'Vericred-Api-Key: YOUR_KEY' -H 'Accept-Version: v2' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
38
+
39
+ ## Pagination
40
+
41
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
42
+ four additional fields that contain data about your position in the response,
43
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
44
+
45
+ For example, to display 5 results per page and view the second page of a
46
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
47
+
48
+ ## Sideloading
49
+
50
+ When we return multiple levels of an object graph (e.g. `Provider`s and their `State`s
51
+ we sideload the associated data. In this example, we would provide an Array of
52
+ `State`s and a `state_id` for each provider. This is done primarily to reduce the
53
+ payload size since many of the `Provider`s will share a `State`
54
+
55
+ ```
56
+ {
57
+ providers: [{ id: 1, state_id: 1}, { id: 2, state_id: 1 }],
58
+ states: [{ id: 1, code: 'NY' }]
59
+ }
60
+ ```
61
+
62
+ If you need the second level of the object graph, you can just match the
63
+ corresponding id.
64
+
65
+ ## Selecting specific data
66
+
67
+ All endpoints allow you to specify which fields you would like to return.
68
+ This allows you to limit the response to contain only the data you need.
69
+
70
+ For example, let's take a request that returns the following JSON by default
71
+
72
+ ```
73
+ {
74
+ provider: {
75
+ id: 1,
76
+ name: 'John',
77
+ phone: '1234567890',
78
+ field_we_dont_care_about: 'value_we_dont_care_about'
79
+ },
80
+ states: [{
81
+ id: 1,
82
+ name: 'New York',
83
+ code: 'NY',
84
+ field_we_dont_care_about: 'value_we_dont_care_about'
85
+ }]
86
+ }
87
+ ```
88
+
89
+ To limit our results to only return the fields we care about, we specify the
90
+ `select` query string parameter for the corresponding fields in the JSON
91
+ document.
92
+
93
+ In this case, we want to select `name` and `phone` from the `provider` key,
94
+ so we would add the parameters `select=provider.name,provider.phone`.
95
+ We also want the `name` and `code` from the `states` key, so we would
96
+ add the parameters `select=states.name,states.code`. The id field of
97
+ each document is always returned whether or not it is requested.
98
+
99
+ Our final request would be `GET /providers/12345?select=provider.name,provider.phone,states.name,states.code`
100
+
101
+ The response would be
102
+
103
+ ```
104
+ {
105
+ provider: {
106
+ id: 1,
107
+ name: 'John',
108
+ phone: '1234567890'
109
+ },
110
+ states: [{
111
+ id: 1,
112
+ name: 'New York',
113
+ code: 'NY'
114
+ }]
115
+ }
116
+ ```
117
+
118
+ ## Benefits summary format
119
+ Benefit cost-share strings are formatted to capture:
120
+ * Network tiers
121
+ * Compound or conditional cost-share
122
+ * Limits on the cost-share
123
+ * Benefit-specific maximum out-of-pocket costs
124
+
125
+ **Example #1**
126
+ As an example, we would represent [this Summary of Benefits & Coverage](https://s3.amazonaws.com/vericred-data/SBC/2017/33602TX0780032.pdf) as:
127
+
128
+ * **Hospital stay facility fees**:
129
+ - Network Provider: `$400 copay/admit plus 20% coinsurance`
130
+ - Out-of-Network Provider: `$1,500 copay/admit plus 50% coinsurance`
131
+ - Vericred's format for this benefit: `In-Network: $400 before deductible then 20% after deductible / Out-of-Network: $1,500 before deductible then 50% after deductible`
132
+
133
+ * **Rehabilitation services:**
134
+ - Network Provider: `20% coinsurance`
135
+ - Out-of-Network Provider: `50% coinsurance`
136
+ - Limitations & Exceptions: `35 visit maximum per benefit period combined with Chiropractic care.`
137
+ - Vericred's format for this benefit: `In-Network: 20% after deductible / Out-of-Network: 50% after deductible | limit: 35 visit(s) per Benefit Period`
138
+
139
+ **Example #2**
140
+ In [this other Summary of Benefits & Coverage](https://s3.amazonaws.com/vericred-data/SBC/2017/40733CA0110568.pdf), the **specialty_drugs** cost-share has a maximum out-of-pocket for in-network pharmacies.
141
+ * **Specialty drugs:**
142
+ - Network Provider: `40% coinsurance up to a $500 maximum for up to a 30 day supply`
143
+ - Out-of-Network Provider `Not covered`
144
+ - Vericred's format for this benefit: `In-Network: 40% after deductible, up to $500 per script / Out-of-Network: 100%`
145
+
146
+ **BNF**
147
+
148
+ Here's a description of the benefits summary string, represented as a context-free grammar:
149
+
150
+ ```
151
+ root ::= coverage
152
+
153
+ coverage ::= (simple_coverage | tiered_coverage) (space pipe space coverage_modifier)?
154
+ tiered_coverage ::= tier (space slash space tier)*
155
+ tier ::= tier_name colon space (tier_coverage | not_applicable)
156
+ tier_coverage ::= simple_coverage (space (then | or | and) space simple_coverage)* tier_limitation?
157
+ simple_coverage ::= (pre_coverage_limitation space)? coverage_amount (space post_coverage_limitation)? (comma? space coverage_condition)?
158
+ coverage_modifier ::= limit_condition colon space (((simple_coverage | simple_limitation) (semicolon space see_carrier_documentation)?) | see_carrier_documentation | waived_if_admitted | shared_across_tiers)
159
+ waived_if_admitted ::= ("copay" space)? "waived if admitted"
160
+ simple_limitation ::= pre_coverage_limitation space "copay applies"
161
+ tier_name ::= "In-Network-Tier-2" | "Out-of-Network" | "In-Network"
162
+ limit_condition ::= "limit" | "condition"
163
+ tier_limitation ::= comma space "up to" space (currency | (integer space time_unit plural?)) (space post_coverage_limitation)?
164
+ coverage_amount ::= currency | unlimited | included | unknown | percentage | (digits space (treatment_unit | time_unit) plural?)
165
+ pre_coverage_limitation ::= first space digits space time_unit plural?
166
+ post_coverage_limitation ::= (((then space currency) | "per condition") space)? "per" space (treatment_unit | (integer space time_unit) | time_unit) plural?
167
+ coverage_condition ::= ("before deductible" | "after deductible" | "penalty" | allowance | "in-state" | "out-of-state") (space allowance)?
168
+ allowance ::= upto_allowance | after_allowance
169
+ upto_allowance ::= "up to" space (currency space)? "allowance"
170
+ after_allowance ::= "after" space (currency space)? "allowance"
171
+ see_carrier_documentation ::= "see carrier documentation for more information"
172
+ shared_across_tiers ::= "shared across all tiers"
173
+ unknown ::= "unknown"
174
+ unlimited ::= /[uU]nlimited/
175
+ included ::= /[iI]ncluded in [mM]edical/
176
+ time_unit ::= /[hH]our/ | (((/[cC]alendar/ | /[cC]ontract/) space)? /[yY]ear/) | /[mM]onth/ | /[dD]ay/ | /[wW]eek/ | /[vV]isit/ | /[lL]ifetime/ | ((((/[bB]enefit/ plural?) | /[eE]ligibility/) space)? /[pP]eriod/)
177
+ treatment_unit ::= /[pP]erson/ | /[gG]roup/ | /[cC]ondition/ | /[sS]cript/ | /[vV]isit/ | /[eE]xam/ | /[iI]tem/ | /[sS]tay/ | /[tT]reatment/ | /[aA]dmission/ | /[eE]pisode/
178
+ comma ::= ","
179
+ colon ::= ":"
180
+ semicolon ::= ";"
181
+ pipe ::= "|"
182
+ slash ::= "/"
183
+ plural ::= "(s)" | "s"
184
+ then ::= "then" | ("," space) | space
185
+ or ::= "or"
186
+ and ::= "and"
187
+ not_applicable ::= "Not Applicable" | "N/A" | "NA"
188
+ first ::= "first"
189
+ currency ::= "$" number
190
+ percentage ::= number "%"
191
+ number ::= float | integer
192
+ float ::= digits "." digits
193
+ integer ::= /[0-9]/+ (comma_int | under_int)*
194
+ comma_int ::= ("," /[0-9]/*3) !"_"
195
+ under_int ::= ("_" /[0-9]/*3) !","
196
+ digits ::= /[0-9]/+ ("_" /[0-9]/+)*
197
+ space ::= /[ \t]/+
198
+ ```
199
+
200
+
5
201
 
6
202
  OpenAPI spec version: 1.0.0
7
203
 
8
204
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.3.1
205
+
206
+ Licensed under the Apache License, Version 2.0 (the "License");
207
+ you may not use this file except in compliance with the License.
208
+ You may obtain a copy of the License at
209
+
210
+ http://www.apache.org/licenses/LICENSE-2.0
211
+
212
+ Unless required by applicable law or agreed to in writing, software
213
+ distributed under the License is distributed on an "AS IS" BASIS,
214
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
215
+ See the License for the specific language governing permissions and
216
+ limitations under the License.
10
217
 
11
218
  =end
12
219
 
@@ -14,7 +221,7 @@ require 'date'
14
221
  require 'json'
15
222
  require 'logger'
16
223
  require 'tempfile'
17
- require 'typhoeus'
224
+ require 'httpclient'
18
225
  require 'uri'
19
226
 
20
227
  module VericredClient
@@ -47,26 +254,17 @@ module VericredClient
47
254
  # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
48
255
  # the data deserialized from response body (could be nil), response status code and response headers.
49
256
  def call_api(http_method, path, opts = {})
50
- request = build_request(http_method, path, opts)
51
- response = request.run
257
+ response = run_request(http_method, path, opts)
52
258
 
53
259
  if @config.debugging
54
260
  @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
55
261
  end
56
262
 
57
- unless response.success?
58
- if response.timed_out?
59
- fail ApiError.new('Connection timed out')
60
- elsif response.code == 0
61
- # Errors from libcurl will be made visible here
62
- fail ApiError.new(:code => 0,
63
- :message => response.return_message)
64
- else
65
- fail ApiError.new(:code => response.code,
66
- :response_headers => response.headers,
67
- :response_body => response.body),
68
- response.status_message
69
- end
263
+ unless response.ok?
264
+ fail ApiError.new(:code => response.code,
265
+ :response_headers => response.header,
266
+ :response_body => response.body),
267
+ response.reason
70
268
  end
71
269
 
72
270
  if opts[:return_type]
@@ -74,7 +272,7 @@ module VericredClient
74
272
  else
75
273
  data = nil
76
274
  end
77
- return data, response.code, response.headers
275
+ return data, response.code, response.header
78
276
  end
79
277
 
80
278
  # Builds the HTTP request
@@ -85,8 +283,8 @@ module VericredClient
85
283
  # @option opts [Hash] :query_params Query parameters
86
284
  # @option opts [Hash] :form_params Query parameters
87
285
  # @option opts [Object] :body HTTP body (JSON/XML)
88
- # @return [Typhoeus::Request] A Typhoeus Request
89
- def build_request(http_method, path, opts = {})
286
+ # @return [HTTP::Message] An HTTP Message
287
+ def run_request(http_method, path, opts = {})
90
288
  url = build_request_url(path)
91
289
  http_method = http_method.to_sym.downcase
92
290
 
@@ -100,15 +298,8 @@ module VericredClient
100
298
  _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
101
299
 
102
300
  req_opts = {
103
- :method => http_method,
104
- :headers => header_params,
105
- :params => query_params,
106
- :params_encoding => @config.params_encoding,
107
- :timeout => @config.timeout,
108
- :ssl_verifypeer => @config.verify_ssl,
109
- :ssl_verifyhost => _verify_ssl_host,
110
- :sslcert => @config.cert_file,
111
- :sslkey => @config.key_file,
301
+ :header => header_params,
302
+ :query => query_params,
112
303
  :verbose => @config.debugging
113
304
  }
114
305
 
@@ -123,9 +314,7 @@ module VericredClient
123
314
  end
124
315
  end
125
316
 
126
- request = Typhoeus::Request.new(url, req_opts)
127
- download_file(request) if opts[:return_type] == 'File'
128
- request
317
+ http_client.send(http_method, url, req_opts)
129
318
  end
130
319
 
131
320
  # Check if the given MIME is a JSON MIME.
@@ -133,11 +322,10 @@ module VericredClient
133
322
  # application/json
134
323
  # application/json; charset=UTF8
135
324
  # APPLICATION/JSON
136
- # */*
137
325
  # @param [String] mime MIME
138
326
  # @return [Boolean] True if the MIME is application/json
139
327
  def json_mime?(mime)
140
- (mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
328
+ !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
141
329
  end
142
330
 
143
331
  # Deserialize the response to the given return type.
@@ -146,16 +334,14 @@ module VericredClient
146
334
  # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
147
335
  def deserialize(response, return_type)
148
336
  body = response.body
149
-
150
- # handle file downloading - return the File instance processed in request callbacks
151
- # note that response body is empty when the file is written in chunks in request on_body callback
152
- return @tempfile if return_type == 'File'
153
-
154
337
  return nil if body.nil? || body.empty?
155
338
 
156
339
  # return response body directly for String return type
157
340
  return body if return_type == 'String'
158
341
 
342
+ # handle file downloading - save response body into a tmp file and return the File instance
343
+ return download_file(response) if return_type == 'File'
344
+
159
345
  # ensuring a default content type
160
346
  content_type = response.headers['Content-Type'] || 'application/json'
161
347
 
@@ -174,6 +360,16 @@ module VericredClient
174
360
  convert_to_type data, return_type
175
361
  end
176
362
 
363
+ # retrieve a new HTTPClient
364
+ # @return [HTTPClient] Instance of Client
365
+ def http_client
366
+ client = HTTPClient.new
367
+ client.receive_timeout = @config.timeout
368
+ client.ssl_config.set_client_cert_file(@config.cert_file, @config.key_file)
369
+ client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT unless @config.verify_ssl
370
+ client
371
+ end
372
+
177
373
  # Convert data to the given return type.
178
374
  # @param [Object] data Data to be converted
179
375
  # @param [String] return_type Return type
@@ -218,38 +414,30 @@ module VericredClient
218
414
 
219
415
  # Save response body into a file in (the defined) temporary folder, using the filename
220
416
  # from the "Content-Disposition" header if provided, otherwise a random filename.
221
- # The response body is written to the file in chunks in order to handle files which
222
- # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
223
- # process can use.
224
417
  #
225
418
  # @see Configuration#temp_folder_path
226
- def download_file(request)
227
- tempfile = nil
228
- encoding = nil
229
- request.on_headers do |response|
230
- content_disposition = response.headers['Content-Disposition']
231
- if content_disposition and content_disposition =~ /filename=/i
232
- filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
233
- prefix = sanitize_filename(filename)
234
- else
235
- prefix = 'download-'
236
- end
237
- prefix = prefix + '-' unless prefix.end_with?('-')
238
- encoding = response.body.encoding
239
- tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
240
- @tempfile = tempfile
241
- end
242
- request.on_body do |chunk|
243
- chunk.force_encoding(encoding)
244
- tempfile.write(chunk)
419
+ # @return [Tempfile] the file downloaded
420
+ def download_file(response)
421
+ content_disposition = response.headers['Content-Disposition']
422
+ if content_disposition and content_disposition =~ /filename=/i
423
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
424
+ prefix = sanitize_filename(filename)
425
+ else
426
+ prefix = 'download-'
245
427
  end
246
- request.on_complete do |response|
247
- tempfile.close
248
- @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
249
- "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
250
- "will be deleted automatically with GC. It's also recommended to delete the temp file "\
251
- "explicitly with `tempfile.delete`"
428
+ prefix = prefix + '-' unless prefix.end_with?('-')
429
+
430
+ tempfile = nil
431
+ encoding = response.body.encoding
432
+ Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file|
433
+ file.write(response.body)
434
+ tempfile = file
252
435
  end
436
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
437
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
438
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
439
+ "explicitly with `tempfile.delete`"
440
+ tempfile
253
441
  end
254
442
 
255
443
  # Sanitize filename by removing path.
@@ -280,7 +468,7 @@ module VericredClient
280
468
  data = {}
281
469
  form_params.each do |key, value|
282
470
  case value
283
- when ::File, ::Array, nil
471
+ when File, Array, nil
284
472
  # let typhoeus handle File, Array and nil parameters
285
473
  data[key] = value
286
474
  else