vericred_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 945030aaf97fceaacfa3cfb248e31fbdd6dbe12d
+  data.tar.gz: 6bb7645738cfe35e12898c55563f541574726fcf
+SHA512:
+  metadata.gz: 717c505e5ebc629e90da6ba08b89e0f5f6ba7ee744ec2f0b970d64b9dec9a1a376a2013dab0980fc853177d3c16d59075262498657b7f97b76577c855788741b
+  data.tar.gz: fc71bec4b5f38c3539bc026f541364cb9a96811ada07cb258da525ab9da290bb1695746019c1ef8892c157ef338b0baf37be06d2a9204916e4fa0a55ec7fe7dc

data/README.md

@@ -0,0 +1,225 @@
+# vericred_client
+
+VericredClient - the Ruby gem for the Vericred API
+
+Vericred's API allows you to search for Health Plans that a specific doctor
+accepts.
+
+## Getting Started
+
+Visit our [Developer Portal](https://vericred.3scale.net/access_code?access_code=vericred&cms_token=3545ca52af07bde85b7c0c3aa9d1985e) 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).
+
+## 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
+
+Most endpoints are not paginated.  It will be noted in the documentation if/when
+an endpoint is paginated.
+
+When pagination is present, a `meta` stanza will be present in the response
+with the total number of records
+
+```
+{
+  things: [{ id: 1 }, { id: 2 }],
+  meta: { total: 500 }
+}
+```
+
+## 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,staes.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'
+  }]
+}
+```
+
+
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 
+- Package version: 0.0.1
+- Build date: 2016-04-29T19:28:54.758-04:00
+- Build package: class io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build vericred_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./vericred_client-0.0.1.gem
+```
+(for development, run `gem install --dev ./vericred_client-0.0.1.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'vericred_client', '~> 0.0.1'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USR_ID/YOUR_GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'vericred_client', :git => 'https://github.com/YOUR_GIT_USR_ID/YOUR_GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'vericred_client'
+
+api_instance = VericredClient::DrugCoverageApi.new
+
+ndc = "ndc_example" # String | NDC for a drug
+
+
+begin
+  #Find Drug Coverages for a given NDC
+  result = api_instance.drugs_ndc_coverages_get(ndc)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling DrugCoverageApi->drugs_ndc_coverages_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.vericred.com/*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*VericredClient::DrugCoverageApi* | [**drugs_ndc_coverages_get**](docs/DrugCoverageApi.md#drugs_ndc_coverages_get) | **GET** /drugs/{ndc}/coverages | Find Drug Coverages for a given NDC
+*VericredClient::PlansApi* | [**plans_find_post**](docs/PlansApi.md#plans_find_post) | **POST** /plans/find | Find a set of plans for a Zip Code and County
+*VericredClient::ProvidersApi* | [**providers_get**](docs/ProvidersApi.md#providers_get) | **GET** /providers | Find providers by term and zip code
+*VericredClient::ProvidersApi* | [**providers_npi_get**](docs/ProvidersApi.md#providers_npi_get) | **GET** /providers/{npi} | Find a specific Provider
+*VericredClient::ZipCountiesApi* | [**zip_counties_get**](docs/ZipCountiesApi.md#zip_counties_get) | **GET** /zip_counties | Find Zip Counties by Zip Code
+
+
+## Documentation for Models
+
+ - [VericredClient::Applicant](docs/Applicant.md)
+ - [VericredClient::Carrier](docs/Carrier.md)
+ - [VericredClient::CarrierSubsidiary](docs/CarrierSubsidiary.md)
+ - [VericredClient::County](docs/County.md)
+ - [VericredClient::Drug](docs/Drug.md)
+ - [VericredClient::DrugCoverage](docs/DrugCoverage.md)
+ - [VericredClient::InlineResponse200](docs/InlineResponse200.md)
+ - [VericredClient::InlineResponse2001](docs/InlineResponse2001.md)
+ - [VericredClient::InlineResponse2002](docs/InlineResponse2002.md)
+ - [VericredClient::Plan](docs/Plan.md)
+ - [VericredClient::PlanCounty](docs/PlanCounty.md)
+ - [VericredClient::PlanSearchResult](docs/PlanSearchResult.md)
+ - [VericredClient::Pricing](docs/Pricing.md)
+ - [VericredClient::Provider](docs/Provider.md)
+ - [VericredClient::Query](docs/Query.md)
+ - [VericredClient::RatingArea](docs/RatingArea.md)
+ - [VericredClient::State](docs/State.md)
+ - [VericredClient::ZipCode](docs/ZipCode.md)
+ - [VericredClient::ZipCounty](docs/ZipCounty.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/docs/Applicant.md

@@ -0,0 +1,14 @@
+# VericredClient::Applicant
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Primary key | [optional] 
+**dob** | **Date** | Date of Birth | [optional] 
+**member_id** | **String** | Foreign key to members | [optional] 
+**name** | **String** | Full name of the Applicant | [optional] 
+**relationship** | **String** | Relationship of the Applicant to the Member | [optional] 
+**smoker** | **BOOLEAN** | Does the Applicant smoke? | [optional] 
+**ssn** | **String** | Applicant's Social Security Number | [optional] 
+
+

data/docs/Carrier.md

@@ -0,0 +1,10 @@
+# VericredClient::Carrier
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Primary key | [optional] 
+**name** | **String** | Name of the Carrier | [optional] 
+**logo_path** | **String** | URL for the Carrier's logo | [optional] 
+
+

data/docs/CarrierSubsidiary.md

@@ -0,0 +1,9 @@
+# VericredClient::CarrierSubsidiary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Primary key | [optional] 
+**name** | **String** | Subsidiary name | [optional] 
+
+

data/docs/County.md

@@ -0,0 +1,16 @@
+# VericredClient::County
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Primary key | [optional] 
+**fips_code** | **String** | State FIPS code | [optional] 
+**name** | **String** | Human-readable name | [optional] 
+**state_code** | **String** | Two-character state code | [optional] 
+**state_id** | **Integer** | state relationship | [optional] 
+**state_live** | **BOOLEAN** | Is the state containing this county active for consumers?
+                  *deprecated in favor of last_date_for_individual | [optional] 
+**state_live_for_business** | **BOOLEAN** | Is the state containing this county active for business?
+                  *deprecated in favor of last_date_for_shop | [optional] 
+
+

data/docs/Drug.md

@@ -0,0 +1,10 @@
+# VericredClient::Drug
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ndc** | **String** | National Drug Code ID | [optional] 
+**proprietary_name** | **String** | Proprietary name of drug | [optional] 
+**non_proprietary_name** | **String** | Non-proprietary name of drug | [optional] 
+
+

data/docs/DrugCoverage.md

@@ -0,0 +1,13 @@
+# VericredClient::DrugCoverage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**plan_id** | **String** | Health Insurance Oversight System id | [optional] 
+**ndc_package_code** | **String** | NDC package code | [optional] 
+**tier** | **String** | Tier Name | [optional] 
+**quantity_limit** | **BOOLEAN** | Quantity limit exists | [optional] 
+**prior_authorization** | **BOOLEAN** | Prior authorization required | [optional] 
+**step_therapy** | **BOOLEAN** | Step Treatment required | [optional] 
+
+

data/docs/DrugCoverageApi.md

@@ -0,0 +1,60 @@
+# VericredClient::DrugCoverageApi
+
+All URIs are relative to *https://api.vericred.com/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**drugs_ndc_coverages_get**](DrugCoverageApi.md#drugs_ndc_coverages_get) | **GET** /drugs/{ndc}/coverages | Find Drug Coverages for a given NDC
+
+
+# **drugs_ndc_coverages_get**
+> Array<DrugCoverage> drugs_ndc_coverages_get(ndc)
+
+Find Drug Coverages for a given NDC
+
+Drug Coverages are the specific tier level, quantity limit, prior authorization
+and step therapy for a given Drug/Plan combination.  This endpoint returns
+all DrugCoverages for a given Drug
+
+
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+
+api_instance = VericredClient::DrugCoverageApi.new
+
+ndc = "ndc_example" # String | NDC for a drug
+
+
+begin
+  #Find Drug Coverages for a given NDC
+  result = api_instance.drugs_ndc_coverages_get(ndc)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling DrugCoverageApi->drugs_ndc_coverages_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ndc** | **String**| NDC for a drug | 
+
+### Return type
+
+[**Array<DrugCoverage>**](DrugCoverage.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/InlineResponse200.md

@@ -0,0 +1,9 @@
+# VericredClient::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | **Object** |  | [optional] 
+**providers** | [**Array<Provider>**](Provider.md) |  | [optional] 
+
+

data/docs/InlineResponse2001.md

@@ -0,0 +1,8 @@
+# VericredClient::InlineResponse2001
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | [**Provider**](Provider.md) |  | [optional] 
+
+

data/docs/InlineResponse2002.md

@@ -0,0 +1,10 @@
+# VericredClient::InlineResponse2002
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**zip_counties** | [**Array<ZipCounty>**](ZipCounty.md) |  | [optional] 
+**counties** | [**Array<County>**](County.md) |  | [optional] 
+**zip_codes** | [**Array<ZipCode>**](ZipCode.md) |  | [optional] 
+
+

data/docs/Plan.md

@@ -0,0 +1,53 @@
+# VericredClient::Plan
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**adult_dental** | **BOOLEAN** | Does the plan provide dental coverage for adults? | [optional] 
+**ambulance** | **String** | Benefits string for ambulance coverage | [optional] 
+**benefits_summary_url** | **String** | Link to the summary of benefits and coverage (SBC) document. | [optional] 
+**buy_link** | **String** | Link to a location to purchase the plan. | [optional] 
+**carrier_name** | **String** | Name of the insurance carrier | [optional] 
+**child_dental** | **BOOLEAN** | Does the plan provide dental coverage for children? | [optional] 
+**child_eyewear** | **String** | Child eyewear benefits summary | [optional] 
+**customer_service_phone_number** | **String** | Phone number to contact the insurance carrier | [optional] 
+**durable_medical_equipment** | **String** | Benefits summary for durable medical equipment | [optional] 
+**diagnostic_test** | **String** | Diagnostic tests benefit summary | [optional] 
+**drug_formulary_url** | **String** | Link to the summary of drug benefits for the plan | [optional] 
+**emergency_room** | **String** | Description of costs when visiting the ER | [optional] 
+**family_drug_deductible** | **String** | Deductible for drugs when a family is on the plan. | [optional] 
+**family_drug_moop** | **String** | Maximum out-of-pocket for drugs when a family is on the plan | [optional] 
+**family_medical_deductible** | **String** | Deductible when a family is on the plan | [optional] 
+**family_medical_moop** | **String** | Maximum out-of-pocket when a family is on the plan | [optional] 
+**generic_drugs** | **String** | Cost for generic drugs | [optional] 
+**hios_issuer_id** | **String** |  | [optional] 
+**id** | **String** | Government-issued HIOS plan ID | [optional] 
+**imaging** | **String** | Benefits summary for imaging coverage | [optional] 
+**individual_drug_deductible** | **String** | Deductible for drugs when an individual is on the plan | [optional] 
+**individual_drug_moop** | **String** | Maximum out-of-pocket for drugs when an individual is on the plan | [optional] 
+**individual_medical_deductible** | **String** | Deductible when an individual is on the plan | [optional] 
+**individual_medical_moop** | **String** | Maximum out-of-pocket when an individual is on the plan | [optional] 
+**inpatient_facility** | **String** | Cost under the plan for an inpatient facility | [optional] 
+**inpatient_physician** | **String** | Cost under the plan for an inpatient physician | [optional] 
+**level** | **String** | Plan metal grouping (e.g. platinum, gold, silver, etc) | [optional] 
+**logo_url** | **String** | Link to a copy of the insurance carrier's logo | [optional] 
+**name** | **String** | Marketing name of the plan | [optional] 
+**network_size** | **Integer** | Total number of Providers in network | [optional] 
+**non_preferred_brand_drugs** | **String** | Cost under the plan for non-preferred brand drugs | [optional] 
+**on_market** | **BOOLEAN** | Is the plan on-market? | [optional] 
+**off_market** | **BOOLEAN** | Is the plan off-market? | [optional] 
+**out_of_network_coverage** | **BOOLEAN** | Does this plan provide any out of network coverage? | [optional] 
+**outpatient_facility** | **String** | Benefits summary for outpatient facility coverage | [optional] 
+**outpatient_mental_health** | **String** | Benefits summary for outpatient mental health coverage | [optional] 
+**outpatient_physician** | **String** | Benefits summary for outpatient physician coverage | [optional] 
+**plan_market** | **String** | Market in which the plan is offered (on_marketplace, shop, etc) | [optional] 
+**plan_type** | **String** | Category of the plan (e.g. EPO, HMO, PPO, POS, Indemnity) | [optional] 
+**preferred_brand_drugs** | **String** | Cost under the plan for perferred brand drugs | [optional] 
+**preventative_care** | **String** | Benefits summary for preventative care | [optional] 
+**primary_care_physician** | **String** | Cost under the plan to visit a Primary Care Physician | [optional] 
+**rehabilitation_services** | **String** | Benefits summary for rehabilitation services | [optional] 
+**specialist** | **String** | Cost under the plan to visit a specialist | [optional] 
+**specialty_drugs** | **String** | Cost under the plan for specialty drugs | [optional] 
+**urgent_care** | **String** | Benefits summary for urgent care | [optional] 
+
+

data/docs/PlanCounty.md

@@ -0,0 +1,10 @@
+# VericredClient::PlanCounty
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Primary key | [optional] 
+**plan_id** | **Integer** | Foreign key to plan | [optional] 
+**county_id** | **Integer** | Foreign key to county | [optional] 
+
+

data/docs/PlanSearchResult.md

@@ -0,0 +1,54 @@
+# VericredClient::PlanSearchResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**adult_dental** | **BOOLEAN** | Does the plan provide dental coverage for adults? | [optional] 
+**ambulance** | **String** | Benefits string for ambulance coverage | [optional] 
+**benefits_summary_url** | **String** | Link to the summary of benefits and coverage (SBC) document. | [optional] 
+**buy_link** | **String** | Link to a location to purchase the plan. | [optional] 
+**carrier_name** | **String** | Name of the insurance carrier | [optional] 
+**child_dental** | **BOOLEAN** | Does the plan provide dental coverage for children? | [optional] 
+**child_eyewear** | **String** | Child eyewear benefits summary | [optional] 
+**customer_service_phone_number** | **String** | Phone number to contact the insurance carrier | [optional] 
+**durable_medical_equipment** | **String** | Benefits summary for durable medical equipment | [optional] 
+**diagnostic_test** | **String** | Diagnostic tests benefit summary | [optional] 
+**drug_formulary_url** | **String** | Link to the summary of drug benefits for the plan | [optional] 
+**emergency_room** | **String** | Description of costs when visiting the ER | [optional] 
+**family_drug_deductible** | **String** | Deductible for drugs when a family is on the plan. | [optional] 
+**family_drug_moop** | **String** | Maximum out-of-pocket for drugs when a family is on the plan | [optional] 
+**family_medical_deductible** | **String** | Deductible when a family is on the plan | [optional] 
+**family_medical_moop** | **String** | Maximum out-of-pocket when a family is on the plan | [optional] 
+**generic_drugs** | **String** | Cost for generic drugs | [optional] 
+**hios_issuer_id** | **String** |  | [optional] 
+**id** | **String** | Government-issued HIOS plan ID | [optional] 
+**imaging** | **String** | Benefits summary for imaging coverage | [optional] 
+**individual_drug_deductible** | **String** | Deductible for drugs when an individual is on the plan | [optional] 
+**individual_drug_moop** | **String** | Maximum out-of-pocket for drugs when an individual is on the plan | [optional] 
+**individual_medical_deductible** | **String** | Deductible when an individual is on the plan | [optional] 
+**individual_medical_moop** | **String** | Maximum out-of-pocket when an individual is on the plan | [optional] 
+**inpatient_facility** | **String** | Cost under the plan for an inpatient facility | [optional] 
+**inpatient_physician** | **String** | Cost under the plan for an inpatient physician | [optional] 
+**level** | **String** | Plan metal grouping (e.g. platinum, gold, silver, etc) | [optional] 
+**logo_url** | **String** | Link to a copy of the insurance carrier's logo | [optional] 
+**name** | **String** | Marketing name of the plan | [optional] 
+**non_preferred_brand_drugs** | **String** | Cost under the plan for non-preferred brand drugs | [optional] 
+**on_market** | **BOOLEAN** | Is the plan on-market? | [optional] 
+**off_market** | **BOOLEAN** | Is the plan off-market? | [optional] 
+**out_of_network_coverage** | **BOOLEAN** | Does this plan provide any out of network coverage? | [optional] 
+**outpatient_facility** | **String** | Benefits summary for outpatient facility coverage | [optional] 
+**outpatient_mental_health** | **String** | Benefits summary for outpatient mental health coverage | [optional] 
+**outpatient_physician** | **String** | Benefits summary for outpatient physician coverage | [optional] 
+**plan_market** | **String** | Market in which the plan is offered (on_marketplace, shop, etc) | [optional] 
+**plan_type** | **String** | Category of the plan (e.g. EPO, HMO, PPO, POS, Indemnity) | [optional] 
+**preferred_brand_drugs** | **String** | Cost under the plan for perferred brand drugs | [optional] 
+**preventative_care** | **String** | Benefits summary for preventative care | [optional] 
+**primary_care_physician** | **String** | Cost under the plan to visit a Primary Care Physician | [optional] 
+**rehabilitation_services** | **String** | Benefits summary for rehabilitation services | [optional] 
+**specialist** | **String** | Cost under the plan to visit a specialist | [optional] 
+**specialty_drugs** | **String** | Cost under the plan for specialty drugs | [optional] 
+**urgent_care** | **String** | Benefits summary for urgent care | [optional] 
+**match_percentage** | **Integer** | Percentage of doctors who matched this Plan | [optional] 
+**perfect_match_percentage** | **Integer** | Percentage of employees with 100% match | [optional] 
+
+

data/docs/PlansApi.md

@@ -0,0 +1,118 @@
+# VericredClient::PlansApi
+
+All URIs are relative to *https://api.vericred.com/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**plans_find_post**](PlansApi.md#plans_find_post) | **POST** /plans/find | Find a set of plans for a Zip Code and County
+
+
+# **plans_find_post**
+> Array<Plan> plans_find_post(query)
+
+Find a set of plans for a Zip Code and County
+
+### Location Information
+
+Searching for a set of plans requires a `zip_code` and `fips_code`
+code.  These are used to determine pricing and availabity
+of health plans.
+
+Optionally, you may provide a list of Applicants or Providers
+
+### Applicants
+
+This is a list of people who will be covered by the plan.  We
+use this list to calculate the premium.  You must include `age`
+and can include `smoker`, which also factors into pricing in some
+states.
+
+Applicants *must* include an age.  If smoker is omitted, its value is assumed
+to be false.
+
+#### Multiple Applicants
+
+To get pricing for multiple applicants, just append multiple sets
+of data to the URL with the age and smoking status of each applicant
+next to each other.
+
+For example, given two applicants - one age 32 and a non-smoker and one
+age 29 and a smoker, you could use the following request
+
+`GET /plans?zip_code=07451&fips_code=33025&applicants[][age]=32&applicants[][age]=29&applicants[][smoker]=true`
+
+It would also be acceptible to include `applicants[][smoker]=false` after the
+first applicant's age.
+
+### Providers
+
+We identify Providers (Doctors) by their National Practitioner
+Index number (NPI).  If you pass a list of Providers, keyed by
+their NPI number, we will return a list of which Providers are
+in and out of network for each plan returned.
+
+For example, if we had two providers with the NPI numbers `12345` and `23456`
+you would make the following request
+
+`GET /plans?zip_code=07451&fips_code=33025&providers[][npi]=12345&providers[][npi]=23456`
+
+### Enrollment Date
+
+To calculate plan pricing and availability, we default to the current date
+as the enrollment date.  To specify a date in the future (or the past), pass
+a string with the format `YYYY-MM-DD` in the `enrollment_date` parameter.
+
+`GET /plans?zip_code=07451&fips_code=33025&enrollment_date=2016-01-01`
+
+### Subsidy
+
+On-marketplace plans are eligible for a subsidy based on the
+`household_size` and `household_income` of the applicants.  If you
+pass those values, we will calculate the `subsidized_premium`
+and return it for each plan.  If no values are provided, the
+`subsidized_premium` will be the same as the `premium`
+
+`GET /plans?zip_code=07451&fips_code=33025&household_size=4&household_income=40000`
+
+
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+
+api_instance = VericredClient::PlansApi.new
+
+query = VericredClient::Query.new # Query | Plan query
+
+
+begin
+  #Find a set of plans for a Zip Code and County
+  result = api_instance.plans_find_post(query)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling PlansApi->plans_find_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | [**Query**](Query.md)| Plan query | 
+
+### Return type
+
+[**Array<Plan>**](Plan.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/Pricing.md

@@ -0,0 +1,12 @@
+# VericredClient::Pricing
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**age** | **Integer** | Age of applicant | [optional] 
+**effective_date** | **Date** | Effective date of plan | [optional] 
+**expiration_date** | **Date** | Plan expiration date | [optional] 
+**plan_id** | **Integer** | Foreign key to plans | [optional] 
+**rating_area_id** | **Integer** | Foreign key to rating areas | [optional] 
+
+