vericred_client 0.0.4 → 0.0.5

data/spec/api/networks_api_spec.rb

@@ -0,0 +1,166 @@
+=begin
+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) 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'
+  }]
+}
+```
+
+
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for VericredClient::NetworksApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'NetworksApi' do
+  before do
+    # run before each test
+    @instance = VericredClient::NetworksApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of NetworksApi' do
+    it 'should create an instact of NetworksApi' do
+      @instance.should be_a(VericredClient::NetworksApi)
+    end
+  end
+
+  # unit tests for list_networks
+  # Networks
+  # A network is a list of the doctors, other health care providers,
+and hospitals that a plan has contracted with to provide medical care to
+its members.
+  # @param carrier_id Carrier HIOS Issuer ID
+  # @param [Hash] opts the optional parameters
+  # @return [NetworkSearchResponse]
+  describe 'list_networks test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+end

data/spec/api/plans_api_spec.rb

@@ -6,7 +6,7 @@ accepts.
 
 ## Getting Started
 
-Visit our [Developer Portal](https://vericred.3scale.net/access_code?access_code=vericred&cms_token=3545ca52af07bde85b7c0c3aa9d1985e) to
+Visit our [Developer Portal](https://vericred.3scale.net) to
 create an account.
 
 Once you have created an account, you can create one Application for
@@ -145,13 +145,73 @@ describe 'PlansApi' do
     end
   end
 
-  # unit tests for post_plans_find
-  # 
-  # 
+  # unit tests for find_plans
+  # Find Plans
+  # ### 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`
+
   # @param [Hash] opts the optional parameters
   # @option opts [RequestPlanFind] :body 
-  # @return [PlanFindResponse]
-  describe 'post_plans_find test' do
+  # @return [PlanSearchResponse]
+  describe 'find_plans test' do
     it "should work" do
       # assertion here
       # should be_a()

data/spec/api/providers_api_spec.rb

@@ -6,7 +6,7 @@ accepts.
 
 ## Getting Started
 
-Visit our [Developer Portal](https://vericred.3scale.net/access_code?access_code=vericred&cms_token=3545ca52af07bde85b7c0c3aa9d1985e) to
+Visit our [Developer Portal](https://vericred.3scale.net) to
 create an account.
 
 Once you have created an account, you can create one Application for
@@ -145,19 +145,14 @@ describe 'ProvidersApi' do
     end
   end
 
-  # unit tests for get_providers
-  # 
-  # 
-  # @param search_term String to search by
-  # @param zip_code Zip Code to search near
+  # unit tests for get_provider
+  # Find a Provider
+  # To retrieve a specific provider, just perform a GET using his NPI number
+  # @param npi NPI number
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :accepts_insurance Limit results to Providers who accept at least one insurance plan.  Note that the inverse of this filter is not supported and any value will evaluate to true
-  # @option opts [String] :page Page number
-  # @option opts [String] :per_page Number of records to return per page
-  # @option opts [String] :radius Radius (in miles) to use to limit results
-  # @option opts [String] :type Either organization or individual
-  # @return [ProviderResponse]
-  describe 'get_providers test' do
+  # @option opts [String] :vericred_api_key API Key
+  # @return [Provider]
+  describe 'get_provider test' do
     it "should work" do
       # assertion here
       # should be_a()
@@ -167,13 +162,26 @@ describe 'ProvidersApi' do
     end
   end
 
-  # unit tests for get_providers_npi
-  # 
-  # 
-  # @param npi NPI number
+  # unit tests for get_providers
+  # Find Providers
+  # All `Provider` searches require a `zip_code`, which we use for weighting
+the search results to favor `Provider`s that are near the user.  For example,
+we would want "Dr. John Smith" who is 5 miles away to appear before
+"Dr. John Smith" who is 100 miles away.
+
+The weighting also allows for non-exact matches.  In our prior example, we
+would want "Dr. Jon Smith" who is 2 miles away to appear before the exact
+match "Dr. John Smith" who is 100 miles away because it is more likely that
+the user just entered an incorrect name.
+
+The free text search also supports Specialty name search and "body part"
+Specialty name search.  So, searching "John Smith nose" would return
+"Dr. John Smith", the ENT Specialist before "Dr. John Smith" the Internist.
+
   # @param [Hash] opts the optional parameters
-  # @return [ProviderResponse]
-  describe 'get_providers_npi test' do
+  # @option opts [RequestProvidersSearch] :body 
+  # @return [ProvidersSearchResponse]
+  describe 'get_providers test' do
     it "should work" do
       # assertion here
       # should be_a()

data/spec/api/zip_counties_api_spec.rb

@@ -6,7 +6,7 @@ accepts.
 
 ## Getting Started
 
-Visit our [Developer Portal](https://vericred.3scale.net/access_code?access_code=vericred&cms_token=3545ca52af07bde85b7c0c3aa9d1985e) to
+Visit our [Developer Portal](https://vericred.3scale.net) to
 create an account.
 
 Once you have created an account, you can create one Application for
@@ -146,10 +146,11 @@ describe 'ZipCountiesApi' do
   end
 
   # unit tests for get_zip_counties
-  # 
-  # 
+  # Search for Zip Counties
+  # Our `Plan` endpoints require a zip code and a fips (county) code.  This is because plan pricing requires both of these elements.  Users are unlikely to know their fips code, so we provide this endpoint to look up a `ZipCounty` by zip code and return both the selected zip and fips codes.
   # @param zip_prefix Partial five-digit Zip
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :vericred_api_key API Key
   # @return [ZipCountyResponse]
   describe 'get_zip_counties test' do
     it "should work" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vericred_client
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Vericred Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -211,26 +211,34 @@ files:
 - docs/DrugSearchResponse.md
 - docs/DrugsApi.md
 - docs/Meta.md
+- docs/Network.md
+- docs/NetworkSearchResponse.md
+- docs/NetworksApi.md
 - docs/Plan.md
 - docs/PlanCounty.md
 - docs/PlanCountyBulk.md
-- docs/PlanFindResponse.md
+- docs/PlanSearchResponse.md
 - docs/PlanSearchResult.md
 - docs/PlansApi.md
 - docs/Pricing.md
 - docs/Provider.md
-- docs/ProviderResponse.md
 - docs/ProvidersApi.md
+- docs/ProvidersSearchResponse.md
 - docs/RatingArea.md
 - docs/RequestPlanFind.md
+- docs/RequestPlanFindApplicant.md
+- docs/RequestPlanFindProvider.md
+- docs/RequestProvidersSearch.md
 - docs/State.md
 - docs/ZipCode.md
 - docs/ZipCountiesApi.md
+- docs/ZipCountiesResponse.md
 - docs/ZipCounty.md
 - docs/ZipCountyBulk.md
 - docs/ZipCountyResponse.md
 - lib/vericred_client.rb
 - lib/vericred_client/api/drugs_api.rb
+- lib/vericred_client/api/networks_api.rb
 - lib/vericred_client/api/plans_api.rb
 - lib/vericred_client/api/providers_api.rb
 - lib/vericred_client/api/zip_counties_api.rb
@@ -249,23 +257,30 @@ files:
 - lib/vericred_client/models/drug_package.rb
 - lib/vericred_client/models/drug_search_response.rb
 - lib/vericred_client/models/meta.rb
+- lib/vericred_client/models/network.rb
+- lib/vericred_client/models/network_search_response.rb
 - lib/vericred_client/models/plan.rb
 - lib/vericred_client/models/plan_county.rb
 - lib/vericred_client/models/plan_county_bulk.rb
-- lib/vericred_client/models/plan_find_response.rb
+- lib/vericred_client/models/plan_search_response.rb
 - lib/vericred_client/models/plan_search_result.rb
 - lib/vericred_client/models/pricing.rb
 - lib/vericred_client/models/provider.rb
-- lib/vericred_client/models/provider_response.rb
+- lib/vericred_client/models/providers_search_response.rb
 - lib/vericred_client/models/rating_area.rb
 - lib/vericred_client/models/request_plan_find.rb
+- lib/vericred_client/models/request_plan_find_applicant.rb
+- lib/vericred_client/models/request_plan_find_provider.rb
+- lib/vericred_client/models/request_providers_search.rb
 - lib/vericred_client/models/state.rb
 - lib/vericred_client/models/zip_code.rb
+- lib/vericred_client/models/zip_counties_response.rb
 - lib/vericred_client/models/zip_county.rb
 - lib/vericred_client/models/zip_county_bulk.rb
 - lib/vericred_client/models/zip_county_response.rb
 - lib/vericred_client/version.rb
 - spec/api/drugs_api_spec.rb
+- spec/api/networks_api_spec.rb
 - spec/api/plans_api_spec.rb
 - spec/api/providers_api_spec.rb
 - spec/api/zip_counties_api_spec.rb
@@ -296,6 +311,7 @@ specification_version: 4
 summary: Vericred API Ruby Gem
 test_files:
 - spec/api/drugs_api_spec.rb
+- spec/api/networks_api_spec.rb
 - spec/api/plans_api_spec.rb
 - spec/api/providers_api_spec.rb
 - spec/api/zip_counties_api_spec.rb