vericred_client 0.0.7 → 0.0.8

data/vericred_client.gemspec

@@ -1,4 +1,135 @@
 # -*- encoding: utf-8 -*-
+#
+=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
+
+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,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
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
 $:.push File.expand_path("../lib", __FILE__)
 require "vericred_client/version"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vericred_client
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Vericred Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -197,6 +197,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - docs/Applicant.md
 - docs/Base.md
@@ -238,6 +239,7 @@ files:
 - docs/ZipCounty.md
 - docs/ZipCountyBulk.md
 - docs/ZipCountyResponse.md
+- git_push.sh
 - lib/vericred_client.rb
 - lib/vericred_client/api/drugs_api.rb
 - lib/vericred_client/api/networks_api.rb
@@ -288,6 +290,44 @@ files:
 - spec/api/plans_api_spec.rb
 - spec/api/providers_api_spec.rb
 - spec/api/zip_counties_api_spec.rb
+- spec/api_client_spec.rb
+- spec/configuration_spec.rb
+- spec/models/applicant_spec.rb
+- spec/models/base_spec.rb
+- spec/models/carrier_spec.rb
+- spec/models/carrier_subsidiary_spec.rb
+- spec/models/county_bulk_spec.rb
+- spec/models/county_spec.rb
+- spec/models/drug_coverage_response_spec.rb
+- spec/models/drug_coverage_spec.rb
+- spec/models/drug_package_spec.rb
+- spec/models/drug_search_response_spec.rb
+- spec/models/drug_spec.rb
+- spec/models/meta_spec.rb
+- spec/models/network_search_response_spec.rb
+- spec/models/network_spec.rb
+- spec/models/plan_county_bulk_spec.rb
+- spec/models/plan_county_spec.rb
+- spec/models/plan_search_response_spec.rb
+- spec/models/plan_search_result_spec.rb
+- spec/models/plan_spec.rb
+- spec/models/plan_zip_county_spec.rb
+- spec/models/pricing_spec.rb
+- spec/models/provider_show_response_spec.rb
+- spec/models/provider_spec.rb
+- spec/models/providers_search_response_spec.rb
+- spec/models/rating_area_spec.rb
+- spec/models/request_plan_find_applicant_spec.rb
+- spec/models/request_plan_find_provider_spec.rb
+- spec/models/request_plan_find_spec.rb
+- spec/models/request_providers_search_spec.rb
+- spec/models/state_spec.rb
+- spec/models/zip_code_spec.rb
+- spec/models/zip_counties_response_spec.rb
+- spec/models/zip_county_bulk_spec.rb
+- spec/models/zip_county_response_spec.rb
+- spec/models/zip_county_spec.rb
+- spec/spec_helper.rb
 - vericred_client.gemspec
 homepage: https://github.com/vericred_client
 licenses:
@@ -319,3 +359,41 @@ test_files:
 - spec/api/plans_api_spec.rb
 - spec/api/providers_api_spec.rb
 - spec/api/zip_counties_api_spec.rb
+- spec/api_client_spec.rb
+- spec/configuration_spec.rb
+- spec/models/applicant_spec.rb
+- spec/models/base_spec.rb
+- spec/models/carrier_spec.rb
+- spec/models/carrier_subsidiary_spec.rb
+- spec/models/county_bulk_spec.rb
+- spec/models/county_spec.rb
+- spec/models/drug_coverage_response_spec.rb
+- spec/models/drug_coverage_spec.rb
+- spec/models/drug_package_spec.rb
+- spec/models/drug_search_response_spec.rb
+- spec/models/drug_spec.rb
+- spec/models/meta_spec.rb
+- spec/models/network_search_response_spec.rb
+- spec/models/network_spec.rb
+- spec/models/plan_county_bulk_spec.rb
+- spec/models/plan_county_spec.rb
+- spec/models/plan_search_response_spec.rb
+- spec/models/plan_search_result_spec.rb
+- spec/models/plan_spec.rb
+- spec/models/plan_zip_county_spec.rb
+- spec/models/pricing_spec.rb
+- spec/models/provider_show_response_spec.rb
+- spec/models/provider_spec.rb
+- spec/models/providers_search_response_spec.rb
+- spec/models/rating_area_spec.rb
+- spec/models/request_plan_find_applicant_spec.rb
+- spec/models/request_plan_find_provider_spec.rb
+- spec/models/request_plan_find_spec.rb
+- spec/models/request_providers_search_spec.rb
+- spec/models/state_spec.rb
+- spec/models/zip_code_spec.rb
+- spec/models/zip_counties_response_spec.rb
+- spec/models/zip_county_bulk_spec.rb
+- spec/models/zip_county_response_spec.rb
+- spec/models/zip_county_spec.rb
+- spec/spec_helper.rb