vericred_client 0.0.11 → 0.0.18

data/docs/{PlanSearchResponseMeta.md → MetaPlanSearchResponse.md}

@@ -1,9 +1,10 @@
-# VericredClient::PlanSearchResponseMeta
+# VericredClient::MetaPlanSearchResponse
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **total** | **Integer** | Number of entities returned | [optional] 
 **eligible_for_chip_medicaid** | **BOOLEAN** | Is this applicant potentially eligible for Chip or Medicaid? | [optional] 
+**premium_tax_credit** | **Float** | The premium tax credit amount calculated for the applicants in the request. | [optional] 
 
 

data/docs/NetworkComparison.md

@@ -0,0 +1,13 @@
+# VericredClient::NetworkComparison
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accepting_insurance_count** | **Integer** | Number of providers in the area who accept any insurance | [optional] 
+**base_network_id** | **Integer** | Primary key of the base network | [optional] 
+**base_network_unique_count** | **Integer** | Number of providers in the base network who are not in the comparison network | [optional] 
+**comparison_network_id** | **Integer** | Primary key of the comparison network | [optional] 
+**comparison_network_unique_count** | **Integer** | Number of providers in the comparison network who are not in the base network | [optional] 
+**network_overlap_count** | **Integer** | Number of providers who are in both networks | [optional] 
+
+

data/docs/NetworkComparisonRequest.md

@@ -0,0 +1,10 @@
+# VericredClient::NetworkComparisonRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**network_ids** | **Array<Integer>** | List of Networks with which to compare the base Network | [optional] 
+**radius** | **Integer** | Radius from the provided Zip Code within which to search | [optional] 
+**zip_code** | **String** | Zip Code to use as a search origin | [optional] 
+
+

data/docs/NetworkComparisonResponse.md

@@ -0,0 +1,9 @@
+# VericredClient::NetworkComparisonResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**networks** | [**Array<Network>**](Network.md) | Networks | [optional] 
+**network_comparisons** | [**Array<NetworkComparison>**](NetworkComparison.md) | NetworkComparisons | [optional] 
+
+

data/docs/NetworksApi.md

@@ -4,10 +4,68 @@ All URIs are relative to *https://api.vericred.com/*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**create_network_comparisons**](NetworksApi.md#create_network_comparisons) | **POST** /networks/{id}/network_comparisons | Network Comparisons
 [**list_networks**](NetworksApi.md#list_networks) | **GET** /networks | Networks
 [**show_network**](NetworksApi.md#show_network) | **GET** /networks/{id} | Network Details
 
 
+# **create_network_comparisons**
+> NetworkComparisonResponse create_network_comparisons(id, body)
+
+Network Comparisons
+
+Compare provider counts in a given area between a base network and one or more comparison networks.  #### Comparing Networks Comparison of provider counts within a radius requires that you provide a `zip_code` and `radius` to use as a search area.  The response returns the total number of unique `Providers` in the Base `Network` (i.e. those who are not present in the Comparison `Network`), The number of unique `Provider`s in the Comparison `Network` (i.e. those who are not present in the Base `Network`), and the count of `Provider`s who are in *both* `Network`s
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::NetworksApi.new
+
+id = 100001 # Integer | Primary key of the base network
+
+body = VericredClient::NetworkComparisonRequest.new # NetworkComparisonRequest | 
+
+
+begin
+  #Network Comparisons
+  result = api_instance.create_network_comparisons(id, body)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling NetworksApi->create_network_comparisons: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Primary key of the base network | 
+ **body** | [**NetworkComparisonRequest**](NetworkComparisonRequest.md)|  | 
+
+### Return type
+
+[**NetworkComparisonResponse**](NetworkComparisonResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **list_networks**
 > NetworkSearchResponse list_networks(carrier_id, opts)
 

data/docs/NotificationSubscription.md

@@ -0,0 +1,8 @@
+# VericredClient::NotificationSubscription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nonce** | **String** | The identifier of the notification subscription. | [optional] 
+
+

data/docs/NotificationSubscriptionResponse.md

@@ -0,0 +1,8 @@
+# VericredClient::NotificationSubscriptionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscription** | [**NotificationSubscription**](NotificationSubscription.md) | Notification subscription details | [optional] 
+
+

data/docs/Plan.md

@@ -3,75 +3,16 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**adult_dental** | **BOOLEAN** | Does the plan provide dental coverage for adults? | [optional] 
-**age29_rider** | **BOOLEAN** | True if the plan allows dependents up to age 29 | [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] 
-**child_eye_exam** | **String** | Child eye exam 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] 
 **display_name** | **String** | Alternate name for the Plan | [optional] 
-**dp_rider** | **BOOLEAN** | True if plan does not cover domestic partners | [optional] 
-**drug_formulary_url** | **String** | Link to the summary of drug benefits for the plan | [optional] 
 **effective_date** | **String** | Effective date of coverage. | [optional] 
 **expiration_date** | **String** | Expiration date of coverage. | [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] 
-**fp_rider** | **BOOLEAN** | True if plan does not cover family planning | [optional] 
-**generic_drugs** | **String** | Cost for generic drugs | [optional] 
-**habilitation_services** | **String** | Habilitation services benefits summary | [optional] 
-**hios_issuer_id** | **String** |  | [optional] 
-**home_health_care** | **String** | Home health care benefits summary | [optional] 
-**hospice_service** | **String** | Hospice service benefits summary | [optional] 
-**hsa_eligible** | **BOOLEAN** | Is the plan HSA eligible? | [optional] 
-**id** | **String** | Government-issued HIOS plan ID | [optional] 
-**imaging** | **String** | Benefits summary for imaging coverage | [optional] 
-**in_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who accept this Plan | [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_birth** | **String** | Inpatient birth benefits summary | [optional] 
-**inpatient_facility** | **String** | Cost under the plan for an inpatient facility | [optional] 
-**inpatient_mental_health** | **String** | Inpatient mental helath benefits summary | [optional] 
-**inpatient_physician** | **String** | Cost under the plan for an inpatient physician | [optional] 
-**inpatient_substance** | **String** | Inpatient substance abuse benefits summary | [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] 
+**identifiers** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | List of identifiers of this Plan | [optional] 
 **name** | **String** | Marketing name of the plan | [optional] 
+**network_ids** | **Array<Integer>** | List of Vericred-generated network_ids | [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] 
-**out_of_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who do not accept this Plan | [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] 
-**outpatient_substance** | **String** | Outpatient substance abuse benefits summary | [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, PACE, Medicare-Medicaid, HMO w/POS, Cost, FFS, MSA) | [optional] 
-**preferred_brand_drugs** | **String** | Cost under the plan for perferred brand drugs | [optional] 
-**prenatal_postnatal_care** | **String** | Inpatient substance abuse benefits summary | [optional] 
-**preventative_care** | **String** | Benefits summary for preventative care | [optional] 
-**premium_subsidized** | **Float** | Cumulative premium amount after subsidy | [optional] 
-**premium** | **Float** | Cumulative premium amount | [optional] 
-**premium_source** | **String** | Source of the base pricing data | [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] 
 **service_area_id** | **String** | Foreign key for service area | [optional] 
-**skilled_nursing** | **String** | Benefits summary for skilled nursing services | [optional] 
 **source** | **String** | Source of the plan benefit data | [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/PlanDeleted.md

@@ -0,0 +1,7 @@
+# VericredClient::PlanDeleted
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/PlanIdentifier.md

@@ -0,0 +1,9 @@
+# VericredClient::PlanIdentifier
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Identifier Type | [optional] 
+**value** | **String** | Identifier Value | [optional] 
+
+

data/docs/PlanMedicare.md

@@ -0,0 +1,19 @@
+# VericredClient::PlanMedicare
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_name** | **String** | Name of the insurance carrier | [optional] 
+**display_name** | **String** | Alternate name for the Plan | [optional] 
+**effective_date** | **String** | Effective date of coverage. | [optional] 
+**expiration_date** | **String** | Expiration date of coverage. | [optional] 
+**identifiers** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | List of identifiers of this Plan | [optional] 
+**name** | **String** | Marketing name of the plan | [optional] 
+**network_ids** | **Array<Integer>** | List of Vericred-generated network_ids | [optional] 
+**network_size** | **Integer** | Total number of Providers in network | [optional] 
+**plan_type** | **String** | Category of the plan (e.g. EPO, HMO, PPO, POS, Indemnity, PACE, Medicare-Medicaid, HMO w/POS, Cost, FFS, MSA) | [optional] 
+**service_area_id** | **String** | Foreign key for service area | [optional] 
+**source** | **String** | Source of the plan benefit data | [optional] 
+**id** | **String** | Government-issued MedicareAdvantage plan ID | [optional] 
+
+

data/docs/PlanMedicareBulk.md

@@ -0,0 +1,21 @@
+# VericredClient::PlanMedicareBulk
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_name** | **String** | Name of the insurance carrier | [optional] 
+**display_name** | **String** | Alternate name for the Plan | [optional] 
+**effective_date** | **String** | Effective date of coverage. | [optional] 
+**expiration_date** | **String** | Expiration date of coverage. | [optional] 
+**identifiers** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | List of identifiers of this Plan | [optional] 
+**name** | **String** | Marketing name of the plan | [optional] 
+**network_ids** | **Array<Integer>** | List of Vericred-generated network_ids | [optional] 
+**network_size** | **Integer** | Total number of Providers in network | [optional] 
+**plan_type** | **String** | Category of the plan (e.g. EPO, HMO, PPO, POS, Indemnity, PACE, Medicare-Medicaid, HMO w/POS, Cost, FFS, MSA) | [optional] 
+**service_area_id** | **String** | Foreign key for service area | [optional] 
+**source** | **String** | Source of the plan benefit data | [optional] 
+**id** | **String** | Government-issued MedicareAdvantage plan ID | [optional] 
+**formulary_name** | **String** | Name of the Plan's Formulary | [optional] 
+**updated_at** | **String** | Time when plan was last updated | [optional] 
+
+

data/docs/PlanPricingMedicare.md

@@ -0,0 +1,15 @@
+# VericredClient::PlanPricingMedicare
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**effective_date** | **Date** | Date these prices take effect | [optional] 
+**expiration_date** | **Date** | Date these prices expire | [optional] 
+**plan_id** | **String** | Medicare Advantage plan ID | [optional] 
+**rating_area_id** | **String** | Identifier for the plan's rating area | [optional] 
+**health_premium** | **Float** | Medicare Advantage health premium | [optional] 
+**drug_premium** | **Float** | Medicare Advantage drug premium | [optional] 
+**premium_source** | **String** | Source of this pricing data | [optional] 
+**updated_at** | **String** | When this pricing data was last updated | [optional] 
+
+

data/docs/PlanSearchResponse.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **meta** | [**Meta**](Meta.md) | Meta-data | [optional] 
-**plans** | [**Array<Plan>**](Plan.md) | Plan search results | [optional] 
 **coverages** | [**Array<DrugCoverage>**](DrugCoverage.md) | Coverages associated with the plan. | [optional] 
+**plans** | [**Array<ACAPlan>**](ACAPlan.md) | Plan search results | [optional] 
 
 

data/docs/PlanShowResponse.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**plan** | [**Plan**](Plan.md) | Plan response | [optional] 
+**plan** | [**ACAPlan**](ACAPlan.md) | Plan response | [optional] 
 
 

data/docs/PlansApi.md

@@ -4,10 +4,66 @@ All URIs are relative to *https://api.vericred.com/*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**delete_plan**](PlansApi.md#delete_plan) | **DELETE** /plans/{hios}/{year} | Delete a plan
 [**find_plans**](PlansApi.md#find_plans) | **POST** /plans/search | Find Plans
+[**search_rates**](PlansApi.md#search_rates) | **POST** /plans/{id}/rates | Show Plan Rates
 [**show_plan**](PlansApi.md#show_plan) | **GET** /plans/{id} | Show Plan
 
 
+# **delete_plan**
+> delete_plan(hios, year)
+
+Delete a plan
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::PlansApi.new
+
+hios = "12345CA1234567" # String | HIOS ID
+
+year = "2007" # String | Plan year
+
+
+begin
+  #Delete a plan
+  api_instance.delete_plan(hios, year)
+rescue VericredClient::ApiError => e
+  puts "Exception when calling PlansApi->delete_plan: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **hios** | **String**| HIOS ID | 
+ **year** | **String**| Plan year | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **find_plans**
 > PlanSearchResponse find_plans(body)
 
@@ -62,6 +118,60 @@ Name | Type | Description  | Notes
 
 
 
+# **search_rates**
+> ResponseRatesSearch search_rates(body)
+
+Show Plan Rates
+
+Search for the Age-Banded `Rate`s for a given `Plan` with respect to an `enrollment_date`, `zip_code`, and a `fips_code`.
+
+### Example
+```ruby
+# load the gem
+require 'vericred_client'
+# setup authorization
+VericredClient.configure do |config|
+  # Configure API key authorization: Vericred-Api-Key
+  config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
+end
+
+api_instance = VericredClient::PlansApi.new
+
+body = VericredClient::RequestRatesSearch.new # RequestRatesSearch | 
+
+
+begin
+  #Show Plan Rates
+  result = api_instance.search_rates(body)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling PlansApi->search_rates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**RequestRatesSearch**](RequestRatesSearch.md)|  | 
+
+### Return type
+
+[**ResponseRatesSearch**](ResponseRatesSearch.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **show_plan**
 > PlanShowResponse show_plan(id, opts)
 
@@ -86,7 +196,7 @@ api_instance = VericredClient::PlansApi.new
 id = "88582NY0230001" # String | ID of the Plan
 
 opts = { 
-  year: 2016 # Integer | Plan year (defaults to current year)
+  year: 2018 # Integer | Plan year (defaults to current year)
 }
 
 begin

data/docs/Provider.md

@@ -14,7 +14,6 @@ Name | Type | Description | Notes
 **middle_name** | **String** | Middle name for the provider. | [optional] 
 **network_ids** | **Array<Integer>** | Array of network ids | [optional] 
 **organization_name** | **String** | name for the providers of type: organization. | [optional] 
-**personal_phone** | **String** | Personal contact phone for the provider. | [optional] 
 **phone** | **String** | Office phone for the provider | [optional] 
 **presentation_name** | **String** | Preferred name for display (e.g. Dr. Francis White may prefer Dr. Frank White) | [optional] 
 **specialty** | **String** | Name of the primary Specialty | [optional] 
@@ -26,5 +25,6 @@ Name | Type | Description | Notes
 **title** | **String** | Professional title for the provider (e.g. Dr). | [optional] 
 **type** | **String** | Type of NPI number (individual provider vs organization). | [optional] 
 **zip_code** | **String** | Postal code for the provider's address (e.g. 11215) | [optional] 
+**npis** | **Array<Integer>** | The National Provider Index (NPI) numbers associated with this provider. | [optional] 
 
 

data/docs/ProviderDetails.md

@@ -14,7 +14,6 @@ Name | Type | Description | Notes
 **middle_name** | **String** | Middle name for the provider. | [optional] 
 **network_ids** | **Array<Integer>** | Array of network ids | [optional] 
 **organization_name** | **String** | name for the providers of type: organization. | [optional] 
-**personal_phone** | **String** | Personal contact phone for the provider. | [optional] 
 **phone** | **String** | Office phone for the provider | [optional] 
 **presentation_name** | **String** | Preferred name for display (e.g. Dr. Francis White may prefer Dr. Frank White) | [optional] 
 **specialty** | **String** | Name of the primary Specialty | [optional] 
@@ -26,6 +25,7 @@ Name | Type | Description | Notes
 **title** | **String** | Professional title for the provider (e.g. Dr). | [optional] 
 **type** | **String** | Type of NPI number (individual provider vs organization). | [optional] 
 **zip_code** | **String** | Postal code for the provider's address (e.g. 11215) | [optional] 
+**npis** | **Array<Integer>** | The National Provider Index (NPI) numbers associated with this provider. | [optional] 
 **hios_ids** | **Array<String>** | List of HIOS ids for this provider | [optional] 
 
 

data/docs/ProviderNetworkEventNotification.md

@@ -0,0 +1,13 @@
+# VericredClient::ProviderNetworkEventNotification
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nonce** | **String** | The identifier of the notification subscription. | [optional] 
+**event** | **String** | The event that caused the notification. | [optional] 
+**provider_id** | **Integer** | The identifier of the provider that was affected. | [optional] 
+**providers** | [**Array<Provider>**](Provider.md) | A list of providers associated with this notification. | [optional] 
+**network_id** | **Integer** | The identifier of the network that was affected. | [optional] 
+**networks** | [**Array<Network>**](Network.md) | A list of networks associated with this notification. | [optional] 
+
+