vericred_client 0.0.27 → 0.0.33

data/docs/MedicalPlanUpdate.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**abortion_rider** | **BOOLEAN** | True if plan covers abortion when there is no public funding available | [optional] 
 **actively_marketed** | **String** | Indicates whether this plan is being actively marketed by the carrier. | [optional] 
 **actuarial_value** | **Float** | Percentage of total average costs for covered benefits that a plan will cover. | [optional] 
 **age29_rider** | **BOOLEAN** | True if the plan allows dependents up to age 29 | [optional] 
@@ -10,24 +11,27 @@ Name | Type | Description | Notes
 **benefits** | [**MedicalPlanBenefits**](MedicalPlanBenefits.md) | Medical Plan Benefits | [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] 
+**chiropractic_services_bool** | **String** | Chiropractic services string boolean | [optional] 
 **coinsurance** | **Float** | Standard cost share for most benefits | [optional] 
 **covered_ages** | **String** | allowed ages on the plan, possible values: allows adult-only, allows child-only,                allows adult and child-only, child29, requires adult | [optional] 
+**display_name** | **String** | Display alias 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] 
 **embedded_deductible** | **String** | Is the individual deductible for each covered person, embedded in the family deductible | [optional] 
 **essential_health_benefits_percentage** | **Float** | Percentage of essential plan benefits | [optional] 
 **external_id** | **String** | Medical Plan External Identifier | [optional] 
 **external_ids** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | Medical Plan External Identifiers | [optional] 
-**family_tier** | **BOOLEAN** | True if plan is in a fixed family tier state | [optional] 
 **fp_rider** | **BOOLEAN** | True if plan does not cover family planning | [optional] 
 **gated** | **BOOLEAN** | Does the plan's network require a physician referral? | [optional] 
 **hsa_eligible** | **BOOLEAN** | Is the plan HSA eligible? | [optional] 
+**infertility_rider** | **BOOLEAN** | True if plan covers infertility treatment | [optional] 
 **issuer_vericred_id** | **String** | The issuer vericred id | [optional] 
 **key_benefits_complete** | **BOOLEAN** | Indicates whether the plan has meaningful descriptions for these benefits:                individual_medical_deductible, family_medical_deductible, individual_medical_moop, family_medical_moop,                primary_care_physician. | [optional] 
 **level** | **String** | Plan metal grouping (e.g. platinum, gold, silver, etc) | [optional] 
 **mail_order_rx** | **Float** | Multiple of the standard Rx cost share for orders filled via mail order | [optional] 
 **market** | **String** | Market for plan | [optional] 
 **name** | **String** | The medical plan name | [optional] 
+**plan_ancestor** | **String** | A list of plan identifiers and years indicating the previous plans that the plan replaces | [optional] 
 **plan_calendar** | **String** | Are deductibles and MOOPs reset on Dec-31 (\"calendar year\"), 365 day(s) after enrollment date (\"plan year\"), or are both options available (\"both\")? | [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] 
@@ -38,6 +42,7 @@ Name | Type | Description | Notes
 **skilled_nursing_facility_365** | **String** | Does the plan cover full-time, year-round, nursing facilities? | [optional] 
 **source** | **String** | Source of the plan benefit data | [optional] 
 **state_code** | **String** | State code | [optional] 
+**telemedicine** | **String** | Indicates whether there is coverage for the remote delivery of medical benefits | [optional] 
 **year** | **Integer** | Plan year | [optional] 
 
 

data/docs/MedicalPlansApi.md

@@ -4,7 +4,63 @@ All URIs are relative to *https://api.vericred.com/*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**find_major_medical_plans**](MedicalPlansApi.md#find_major_medical_plans) | **POST** /plans/medical/search | Search Plans
 [**put_medical_plan**](MedicalPlansApi.md#put_medical_plan) | **PUT** /plans/medical/{vericred_id} | Create/update a Medical Plan
+[**show_medical_plan**](MedicalPlansApi.md#show_medical_plan) | **GET** /plans/medical/{id} | Show Plan
+
+
+# **find_major_medical_plans**
+> PlanSearchResponse find_major_medical_plans(body)
+
+Search Plans
+
+### Searching for Medical Plans   Determine the available Plans and their Premiums for a particular Family in a given Location.   For details on searching for Plans and their related data, see the [Quoting Medical Plans](#header-major-medical-quotes) section.  ### Parameters | Field                                             | Type     | Notes                                                                                                                     | |---------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------| | zip_code<br />_(required)_                        | `string` |                                                                                                                           | | fips_code<br />_(required)_                       | `string` |                                                                                                                           | | market<br />_(required)_                          | `string` | The options are: `individual` or `small_group`.                                                                           | | enrollment_date<br />_(optional)_                 | `string` | The format is `2019-01-01`. If this is not provided, we default it to today's date.                                       | | applicants<br />_(optional)_                      | `list`   | Use this field to see premiums for `individual` quotes. See below for parameters.                                         | | drug_packages<br />_(optional)_                   | `list`   | Use this field to see drug coverage information by plan. Supply either the NDC Package Code or the Med ID of the `Drug`.  | | household_income<br />_(optional)_                | `int`    | The total household income of the applicant for `individual` quotes.                                                      | | household_size<br />_(optional)_                  | `int`    | The number of applicants and dependents applying for `individual` quotes.                                                 | | ids<br />_(optional)_                             | `list`   | Use this field to hard filter results to certain HIOS IDs.                                                                | | providers<br />_(optional)_                       | `list`   | Use this field to see if providers are in- or out-of-network for each plan by providing their NPIs.                       | | issuer_qualifications_met<br />_(optional)_       | `list`   | A list of HIOS Issuer IDs of which the end-user has answered qualification questions for.                                 |  ### Applicants _(optional)_ | Field                                             | Type      | Notes | |---------------------------------------------------|-----------|-------| | age<br />_(required)_                             | `int`     |       | | child<br />_(required)_                           | `boolean` |       | | smoker<br />_(required)_                          | `boolean` |       |  ### Additional Sorting  Plans can be sorted by the `premium`, `carrier_name`, `level`, and `plan_type` fields, by either ascending (as `asc`) or descending (as `dsc`) sort under the `sort` field.  ### Provider Data  The Major Medical Plans are paired with [Network Provider Data](#header-network-and-provider-data)  ### Drug coverages  Are included along with the rest of the plan data. See [the description below](#drugcoverages) for more details.  ### Issuer Qualifications  Some issuers require end users to answer questions before their plans can be made available to them, e.g. certain Association Health Plans.  Vericred supports this by asking you to confirm that the end user has answered the requisite questions by passing the HIOS Issuer ID of the issuer in the optional `issuer_qualifications_met` request key.  Plans for the requested issuer(s) that are available in the geographic area will have a `-94` suffix in their `id`.   For information on the issuers with qualifications that are supported, please reach out to support@vericred.com.
+
+### 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::MedicalPlansApi.new
+
+body = VericredClient::MedicalPlanSearchRequest.new # MedicalPlanSearchRequest | 
+
+
+begin
+  #Search Plans
+  result = api_instance.find_major_medical_plans(body)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling MedicalPlansApi->find_major_medical_plans: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**MedicalPlanSearchRequest**](MedicalPlanSearchRequest.md)|  | 
+
+### Return type
+
+[**PlanSearchResponse**](PlanSearchResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
 
 
 # **put_medical_plan**
@@ -63,3 +119,61 @@ nil (empty response body)
 
 
 
+# **show_medical_plan**
+> PlanShowResponse show_medical_plan(id, opts)
+
+Show Plan
+
+### Retrieving Benefits for a Medical Plan Show the details of an individual Plan.  This includes all [benefits](#header-major-medical) for the Plan.  For more details on displaying Plans and their related data, see the [Quoting](#header-individual-quotes) section.
+
+### 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::MedicalPlansApi.new
+
+id = "88582NY0230001" # String | ID of the Plan
+
+opts = { 
+  year: 2018 # Integer | Plan year (defaults to current year)
+}
+
+begin
+  #Show Plan
+  result = api_instance.show_medical_plan(id, opts)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling MedicalPlansApi->show_medical_plan: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the Plan | 
+ **year** | **Integer**| Plan year (defaults to current year) | [optional] 
+
+### Return type
+
+[**PlanShowResponse**](PlanShowResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/MedicareAdvantagePlan.md

@@ -11,10 +11,8 @@ Name | Type | Description | Notes
 **customer_service_phone_non_member** | **String** | Customer_service for non-member phone number | [optional] 
 **id** | **String** | The dental plan identifier | [optional] 
 **identifiers** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | List of identifiers of this Plan | [optional] 
-**in_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who accept this Plan | [optional] 
 **logo_url** | **String** | Link to a copy of the insurance carrier's logo | [optional] 
 **name** | **String** | The medicare advantage plan name | [optional] 
-**out_of_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who do not accept this Plan | [optional] 
 **part_b_premium_reduction** | **Float** | Part B premium reduction amount | [optional] 
 **plan_type** | **String** | The type of medicare advantage plan | [optional] 
 **premium_drug** | **Float** | Cumulative premium amount | [optional] 

data/docs/MedicareAdvantagePlanSearch.md

@@ -0,0 +1,30 @@
+# VericredClient::MedicareAdvantagePlanSearch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**audience** | **String** | The medicare advantage plan audience | [optional] 
+**benefits** | [**MedicareAdvantagePlanBenefits**](MedicareAdvantagePlanBenefits.md) | Medicare Advantage Plan Benefits | [optional] 
+**benefits_summary_url** | **String** | Link to the summary of benefits and coverage (SBC) document. | [optional] 
+**carrier_name** | **String** | Name of the insurance carrier | [optional] 
+**customer_service_phone_member** | **String** | Customer Service member phone number | [optional] 
+**customer_service_phone_non_member** | **String** | Customer_service for non-member phone number | [optional] 
+**id** | **String** | The dental plan identifier | [optional] 
+**identifiers** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | List of identifiers of this Plan | [optional] 
+**in_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who accept this Plan | [optional] 
+**logo_url** | **String** | Link to a copy of the insurance carrier's logo | [optional] 
+**name** | **String** | The medicare advantage plan name | [optional] 
+**out_of_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who do not accept this Plan | [optional] 
+**part_b_premium_reduction** | **Float** | Part B premium reduction amount | [optional] 
+**plan_type** | **String** | The type of medicare advantage plan | [optional] 
+**premium_drug** | **Float** | Cumulative premium amount | [optional] 
+**premium_health** | **Float** | Cumulative premium amount | [optional] 
+**source** | **String** | Source of the medicare advantage plan benefit data | [optional] 
+**stand_alone_part_d** | **BOOLEAN** | Stand alone flag for medical advantage plan | [optional] 
+**star_rating_drug_plan** | **Integer** | Star rating for the drug medicare advantage plan | [optional] 
+**star_rating_health_plan** | **Integer** | Star rating for the medical medicare advantage plan | [optional] 
+**star_rating_overall** | **Integer** | Overall star rating for the plan | [optional] 
+**supplemental_options** | [**Array<SupplementalOptions>**](SupplementalOptions.md) | List of supplemental options of this Plan | [optional] 
+**year** | **String** | The year of medicare advantage plan | [optional] 
+
+

data/docs/MedicareAdvantagePlanSearchResponse.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **coverages** | [**Array<DrugCoverage>**](DrugCoverage.md) | Coverages associated with the plan. | [optional] 
 **meta** | [**Meta**](Meta.md) | Meta-data | [optional] 
-**plans** | [**Array<MedicareAdvantagePlan>**](MedicareAdvantagePlan.md) | Medicare Advantage plan search results | [optional] 
+**plans** | [**Array<MedicareAdvantagePlanSearch>**](MedicareAdvantagePlanSearch.md) | Medicare Advantage plan search results | [optional] 
 
 

data/docs/MembersCreateRequest.md

@@ -3,7 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | null | [optional] 
 **members** | [**Array<MemberCreate>**](MemberCreate.md) | List of Members | [optional] 
 
 

data/docs/Plan.md

@@ -4,14 +4,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **identifiers** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | List of identifiers of this Plan | [optional] 
-**in_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who accept this Plan | [optional] 
 **name** | **String** | Marketing name of the plan | [optional] 
 **network_size** | **Integer** | Total number of Providers in network | [optional] 
 **networks** | [**Array<PlanNetwork>**](PlanNetwork.md) | List of networks associated with the plan | [optional] 
-**out_of_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who do not accept this Plan | [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] 
-**premium** | **Float** | Cumulative premium amount | [optional] 
-**premium_source** | **String** | Source of the base pricing data | [optional] 
 **source** | **String** | Source of the plan benefit data | [optional] 
 
 

data/docs/PlanMedicare.md

@@ -5,14 +5,10 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | Government-issued MedicareAdvantage plan ID | [optional] 
 **identifiers** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | List of identifiers of this Plan | [optional] 
-**in_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who accept this Plan | [optional] 
 **name** | **String** | Marketing name of the plan | [optional] 
 **network_size** | **Integer** | Total number of Providers in network | [optional] 
 **networks** | [**Array<PlanNetwork>**](PlanNetwork.md) | List of networks associated with the plan | [optional] 
-**out_of_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who do not accept this Plan | [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] 
-**premium** | **Float** | Cumulative premium amount | [optional] 
-**premium_source** | **String** | Source of the base pricing data | [optional] 
 **source** | **String** | Source of the plan benefit data | [optional] 
 
 

data/docs/PlanMedicareBulk.md

@@ -6,14 +6,10 @@ Name | Type | Description | Notes
 **formulary_name** | **String** | Name of the Plan's Formulary | [optional] 
 **id** | **String** | Government-issued MedicareAdvantage plan ID | [optional] 
 **identifiers** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | List of identifiers of this Plan | [optional] 
-**in_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who accept this Plan | [optional] 
 **name** | **String** | Marketing name of the plan | [optional] 
 **network_size** | **Integer** | Total number of Providers in network | [optional] 
 **networks** | [**Array<PlanNetwork>**](PlanNetwork.md) | List of networks associated with the plan | [optional] 
-**out_of_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who do not accept this Plan | [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] 
-**premium** | **Float** | Cumulative premium amount | [optional] 
-**premium_source** | **String** | Source of the base pricing data | [optional] 
 **source** | **String** | Source of the plan benefit data | [optional] 
 **updated_at** | **String** | Time when plan was last updated | [optional] 
 

data/docs/PlansBulkSearchRequest.md

@@ -0,0 +1,13 @@
+# VericredClient::PlansBulkSearchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**market** | **String** | The market for which the plans are offered, options are: individual or small group. | [optional] 
+**page** | **Integer** | Selected page of paginated response. | [optional] 
+**per_page** | **Integer** | Results per page of response. | [optional] 
+**product_line** | **String** | The line of coverage, options are: medical, dental, or vision. | [optional] 
+**state** | **String** | The two-letter state code where the plans are offered. | [optional] 
+**year** | **String** | The year when the plans are offered. | [optional] 
+
+

data/docs/PlansBulkSearchResponse.md

@@ -0,0 +1,9 @@
+# VericredClient::PlansBulkSearchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Meta**](Meta.md) | Meta-data | [optional] 
+**plans** | [**Array<ACAPlan2018>**](ACAPlan2018.md) | Plan bulk results | [optional] 
+
+

data/docs/Premiums.md

@@ -0,0 +1,11 @@
+# VericredClient::Premiums
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_2_tier_composite** | [**TwoTierComposite**](TwoTierComposite.md) | Two Tier Composite Premiums | [optional] 
+**_3_tier_composite** | [**ThreeTierComposite**](ThreeTierComposite.md) | Three Tier Composite Premiums | [optional] 
+**_4_tier_composite** | [**FourTierComposite**](FourTierComposite.md) | Four Tier Composite Premiums | [optional] 
+**age_banded** | [**AgeBanded**](AgeBanded.md) | Age Banded Premium Totals | [optional] 
+
+

data/docs/ProviderDetails.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **longitude** | **Float** | Longitude of provider | [optional] 
 **middle_name** | **String** | Middle name for the provider. | [optional] 
 **network_ids** | **Array<Integer>** | Array of network ids | [optional] 
+**networks** | [**Array<ProviderNetworks>**](ProviderNetworks.md) | Provider networks | [optional] 
 **npis** | **Array<Integer>** | The National Provider Index (NPI) numbers associated with this provider. | [optional] 
 **organization_name** | **String** | name for the providers of type: organization. | [optional] 
 **phone** | **String** | Office phone for the provider | [optional] 

data/docs/ProviderNetworks.md

@@ -3,12 +3,13 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**addresses** | [**Array<Address>**](Address.md) | Provider Addresses | [optional] 
+**addresses** | [**Array<ProviderNetworksAddress>**](ProviderNetworksAddress.md) | Provider Addresses | [optional] 
 **carrier_name** | **String** | Name of the Network Carrier | [optional] 
 **id** | **Integer** | Primary key | [optional] 
 **name** | **String** | Name of the Network | [optional] 
 **pcp** | **BOOLEAN** | True if the provider is a primary care physician | [optional] 
 **pcp_id** | **String** | Provider PCP Id | [optional] 
 **specialties** | [**Array<ProviderNetworkSpecialty>**](ProviderNetworkSpecialty.md) | Specialties | [optional] 
+**tier** | **String** | Network Tier a provider belongs to | [optional] 
 
 

data/docs/ProviderNetworksAddress.md

@@ -0,0 +1,15 @@
+# VericredClient::ProviderNetworksAddress
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**city** | **String** | City name (e.g. Springfield). | [optional] 
+**latitude** | **Float** | Latitude of provider | [optional] 
+**longitude** | **Float** | Longitude of provider | [optional] 
+**phone_numbers** | **Array<String>** | Provider phone numbers | [optional] 
+**state** | **String** | State code for the provider's address (e.g. NY). | [optional] 
+**street_line_1** | **String** | First line of the provider's street address. | [optional] 
+**street_line_2** | **String** | Second line of the provider's street address. | [optional] 
+**zip_code** | **String** | Postal code for the provider's address (e.g. 11215) | [optional] 
+
+

data/docs/ProviderPlanNetworkResponse.md

@@ -0,0 +1,9 @@
+# VericredClient::ProviderPlanNetworkResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the network | [optional] 
+**tier** | **String** | The network tier for this plan | [optional] 
+
+

data/docs/ProviderPlanResponse.md

@@ -3,10 +3,12 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**carrier_name** | **String** | Name of the insurance carrier | [optional] 
 **external_ids** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | The list of identifiers of the plan. | [optional] 
 **id** | **String** | Indentifier for the plan | [optional] 
 **line_of_coverage** | **String** | The line of coverage for the plan. | [optional] 
 **market** | **String** | The market in which the plan is offered. | [optional] 
 **name** | **String** | Name for the Plan | [optional] 
+**networks** | [**Array<ProviderPlanNetworkResponse>**](ProviderPlanNetworkResponse.md) | The list of networks that a plan belongs to. | [optional] 
 
 

data/docs/ProvidersApi.md

@@ -68,7 +68,7 @@ nil (empty response body)
 
 Provider Plans
 
-Retrieve the plans a provider accepts.  **New Verison:** In order to use this endpoint, please set your version header to `v7`. If you are using previous versions and want to get the list of `plan_ids` that a provider accepts, you can use the `hios_ids` key in the Provider Show `GET /providers/:npi` endpoint.  #### External Id Types   Plan `external_ids` are returned as a list, with each item containing   both a `type` and a `value`. Below is a list of possible types:    | Type           | Description                                                                                                                                          |   | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |   | hios_id        | The HIOS ID of the plan. This type will be returned for under-65 ACA medical plans.                                                                  |   | contract_id    | A contract identifier for the plan. This will be returned for all Medicare Advantage plans and any other plan that contains external contract ids.   |   | package_code   | A package code for the plan. This value will be returned if there is a package in which the plan is bundled.                                        |
+Retrieve the plans a provider accepts.  **New Verison:** In order to use this endpoint, please set your version header to `v7`. If you are using previous versions and want to get the list of `plan_ids` that a provider accepts, you can use the `hios_ids` key in the Provider Show `GET /providers/:npi` endpoint.  #### External Id Types   Plan `external_ids` are returned as a list, with each item containing   both a `type` and a `value`. Below is a list of possible types:    | Type           | Description                                                                                                                                          |   | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |   | hios_id        | The HIOS ID of the plan. This type will be returned for under-65 ACA medical plans.                                                                  |   | contract_id    | A contract identifier for the plan. This will be returned for all Medicare Advantage plans and any other plan that contains external contract ids.   |   | package_code   | A package code for the plan. This value will be returned if there is a package in which the plan is bundled.                                         |
 
 ### Example
 ```ruby
@@ -132,7 +132,7 @@ Name | Type | Description  | Notes
 
 Find Providers
 
-### Provider Details All searches can take a `search_term`, which is used as a component in the score (and thus the ranking/order) of the results.  This is combined with the proximity to the location in ranking results. For example, we would want \"Dr. John Smith\" who is 5 miles away from a given Zip Code 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.  In addition, we can filter `Providers` by whether or not they accept *any* insurance.  Our data set includes over 4 million `Providers`, some of whom do not accept any insurance at all.  This filter makes it more likely that the user will find his or her practitioner in some cases.  ### Location Information  All `Provider` searches that do *not* specify `plan_ids` or `network_ids`require some type of location information. We use this information either to weight results or to filter results, depending on the type.  #### Zip Code When providing the `zip_code` parameter, we order the `Providers` returned based on their score, which incorporates their proximity to the given Zip Code and the closeness of match to the search text.  If a `radius` is also provided, we filter out `Providers` who are outside of that radius from the center of the Zip Code provided.  #### Polygon When providing the `polygon` parameter, we filter providers who are outside the bounds of the shape provided.  This is mutually exclusive with `zip_code` and `radius`.  ### Specialty When providing the `specialty_ids` parameter, we filter providers to those who practice those specialties. To find the specialty_ids, please use the [Specialty Search](#specialtes-specialtes-get) endpoint.  ### Plan/Network Information We can also filter based on `Plan` and `Network` participation, using `plan_ids` and `network_ids`, respectively.  These filters are mutually exclusive and return the union of the resulting sets for each `Plan` or `Network`.  I.e. if you provider Plan A and Plan B, you will receive `Providers` who accept *either* `Plan`.  The same is true for `Networks`. The plan identifiers filter supports: Vericred plan IDs returned from the [Dental](#header-dental-quotes) and [Vision](#header-vision-quotes) endpoints, as well as, HIOS IDs and Medicare contract codes.  ### Examples  *Find Dr. Foo near Brooklyn*  `{ \"search_term\": \"Foo\", \"zip_code\": \"11215\" }`  *Find all Providers within 5 miles of Brooklyn who accept a Plan*  `{ \"zip_code\": \"11215\", \"radius\": 5, \"plan_ids\": [\"88582NY0230001\"] }`  *Find all providers on a map of Brooklyn ordered by a combination of proximity to the center point of the map and relevance to the search term \"ENT\"*  ``` {   \"polygon\": [       {\"lon\":-74.0126609802,\"lat\":40.6275684851 },       {\"lon\":-74.0126609802,\"lat\":40.7097269508 },       {\"lon\":-73.9367866516,\"lat\":40.7097269508 },       {\"lon\":-73.9367866516,\"lat\":40.6275684851 }   ],   \"search_term\" : \"ENT\" } ``` 
+### Provider Details All searches can take a `search_term`, which is used as a component in the score (and thus the ranking/order) of the results.  This is combined with the proximity to the location in ranking results. For example, we would want \"Dr. John Smith\" who is 5 miles away from a given Zip Code 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.  In addition, we can filter `Providers` by whether or not they accept *any* insurance.  Our data set includes over 4 million `Providers`, some of whom do not accept any insurance at all.  This filter makes it more likely that the user will find his or her practitioner in some cases.  ### Location Information  All `Provider` searches that do *not* specify `plan_ids` or `network_ids`require some type of location information. We use this information either to weight results or to filter results, depending on the type.  #### Network IDs This endpoint supports filtering provider search results to only those that are in-network for specific provider networks. To do so, you can provide a `network_ids` key in the request that includes a list of the identifiers for each network to filter on. Please note that the `network_ids` response key will only appear if it is used in the request. The use of this filter is reserved for paying customers.   #### Zip Code When providing the `zip_code` parameter, we order the `Providers` returned based on their score, which incorporates their proximity to the given Zip Code and the closeness of match to the search text.  If a `radius` is also provided, we filter out `Providers` who are outside of that radius from the center of the Zip Code provided.  #### Polygon When providing the `polygon` parameter, we filter providers who are outside the bounds of the shape provided.  This is mutually exclusive with `zip_code` and `radius`.  ### Specialty When providing the `specialty_ids` parameter, we filter providers to those who practice those specialties. To find the specialty_ids, please use the [Specialty Search](#specialtes-specialtes-get) endpoint.  ### Plan/Network Information We can also filter based on `Plan` and `Network` participation, using `plan_ids` and `network_ids`, respectively.  These filters are mutually exclusive and return the union of the resulting sets for each `Plan` or `Network`.  I.e. if you provider Plan A and Plan B, you will receive `Providers` who accept *either* `Plan`.  The same is true for `Networks`. The plan identifiers filter supports: Vericred plan IDs returned from the [Dental](#header-dental-quotes) and [Vision](#header-vision-quotes) endpoints, as well as, HIOS IDs and Medicare contract codes.  ### Examples  *Find Dr. Foo near Brooklyn*  `{ \"search_term\": \"Foo\", \"zip_code\": \"11215\" }`  *Find all Providers within 5 miles of Brooklyn who accept a Plan*  `{ \"zip_code\": \"11215\", \"radius\": 5, \"plan_ids\": [\"88582NY0230001\"] }`  *Find all providers on a map of Brooklyn ordered by a combination of proximity to the center point of the map and relevance to the search term \"ENT\"*  ``` {   \"polygon\": [       {\"lon\":-74.0126609802,\"lat\":40.6275684851 },       {\"lon\":-74.0126609802,\"lat\":40.7097269508 },       {\"lon\":-73.9367866516,\"lat\":40.7097269508 },       {\"lon\":-73.9367866516,\"lat\":40.6275684851 }   ],   \"search_term\" : \"ENT\" } ``` 
 
 ### Example
 ```ruby

data/docs/QuotingApi.md

@@ -17,7 +17,7 @@ Method | HTTP request | Description
 
 Create a Group
 
-Create a new [`Group`](#header-specifying-the-group) with which you can create [`Member`s](#quoting-quoting-put) and [`Quote`s](#quoting-quoting-post-1)
+Use this endpoint to create a new `Group`. See the [Overview Section](#header-specifying-the-group) for more information.  ### Parameters #### Group _(required)_ The `group` key is a required object that contains information related to the group that will be quoted.   | Field                                 | Type      | Notes                                                                        |   |---------------------------------------|-----------|------------------------------------------------------------------------------|   | chamber_association<br />_(required)_ | `boolean` |                                                                              |   | company_name<br />_(required)_        | `string`  |                                                                              |   | contact_email<br />_(optional)_       | `string`  |                                                                              |   | contact_name<br />_(optional)_        | `string`  |                                                                              |   | contact_phone<br />_(optional)_       | `string`  | The format is `123-123-1234`.                                                |   | external_id<br />_(required)_         | `string`  | A field you can use to identify the group with. This can be an empty string. |   | sic_code<br />_(required)_            | `string`  |                                                                              |  #### Locations _(required)_ The `locations` key is a requied list of objects, each detailing a location in which the group has an office. There should only be one primary location. The primary location is used to determine the plan availability for that group during the quoting process.   | Field                                 | Type      | Notes                                                                           |   |---------------------------------------|-----------|---------------------------------------------------------------------------------|   | external_id<br />_(optional)_         | `string`  | A field you can use to identify the location with. This can be an empty string. |   | fips_code<br />_(required)_           | `string`  |                                                                                 |   | name<br />_(required)_                | `string`  |                                                                                 |   | number_of_employees<br />_(required)_ | `integer` |                                                                                 |   | primary<br />_(required)_             | `boolean` |                                                                                 |   | zip_code<br />_(required)_            | `string`  |                                                                                 |
 
 ### Example
 ```ruby
@@ -71,7 +71,7 @@ Name | Type | Description  | Notes
 
 Create a Quote
 
-Generate a `Quote` for a `Group`
+Generate a `Quote` for a `Group`. See the [Overview Section](#quoting-quoting-post-1) for more information.  ### Parameters #### Quote _(required)_ The `quote` key is required and it contains the criteria below for the quote that is being generated. | Field                                      | Type      | Notes                                                                                                                                                                            | |--------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | contribution_percentage<br />_(required)_  | `integer` |                                                                                                                                                                                  | | effective_date<br />_(required)_           | `string`  | The format is `YYYY-MM-DD`.                                                                                                                                                      | | npn<br />_(required)_                      | `string`  | The National Producer Number                                                                                                                                                     | | participation_percentage<br />_(required)_ | `integer` |                                                                                                                                                                                  | | product_line<br />_(required)_             | `string`  | The product line you wish to quote for. The options are `medical`, `dental`, or `vision`.                                                                                        | | rating_method<br />_(required)_            | `string`  | The options are `age_banded`, `4_tier_composite`, `3_tier_composite`, and `2_tier_composite`. If we do not have a method for a plan, we will use a method we have for that plan. | | voluntary<br />_(required)_                | `boolean` |                                                                                                                                                                                  | | carrier_ids<br />_(optional)_              | `list`    | A list of issuer_ids in string format. Only provide this key if you want to limit the carriers quoted.                                                                           |
 
 ### Example
 ```ruby
@@ -183,7 +183,7 @@ Name | Type | Description  | Notes
 
 Display Rates
 
-null
+Retrieve the rates for a `Quote`.  **Notice:** Please note that the `premiums` key is currently only available for `medical` Quotes. Please reach out to support@vericred.com for updates on its availability for `dental` and `vision` quotes.
 
 ### Example
 ```ruby
@@ -237,7 +237,7 @@ Name | Type | Description  | Notes
 
 Display Member Rates
 
-null
+Retrieve the member-level rates for a particular `Rate` returned for a `Quote`.
 
 ### Example
 ```ruby
@@ -287,11 +287,11 @@ Name | Type | Description  | Notes
 
 
 # **update_group_members**
-> update_group_members(id, body)
+> MembersCreateResponse update_group_members(id, body)
 
 Create or Update Members
 
-Specify the `Member`s and `Dependent`s for the `Group`
+Add `Member`s and their `Dependent`s to a `Group`. If called on the same group twice, it will fully replace the members for that group. See the [Overview Section](#quoting-quoting-put) for more information. ### Parameters #### Members _(required)_ The `members` key is a required list containing the `Member`s for the `Group` and their `Dependent`s.  | Field                                 | Type      | Notes                                                                                                | |---------------------------------------|-----------|------------------------------------------------------------------------------------------------------| | cobra<br />_(required)_               | `boolean` |                                                                                                      | | date_of_birth<br />_(required)_       | `string`  | The format is `YYYY-MM-DD`. Members cannot be less than 0 years old at the time of quoting.          | | dependents<br />_(required)_          | `list`    | If the member does not have dependents, please pass an empty list.                                   | | external_id<br />_(required)_         | `string`  | A field you can use to identify the member with. This can be an empty string.                        | | fips_code<br />_(required)_           | `string`  |                                                                                                      | | gender<br />_(required)_              | `string`  | The options are: `M` or `F`.                                                                         | | last_used_tobacco<br />_(required)_   | `string`  | The format is `YYYY-MM-DD`. For those that have never smoked, please pass `null`.                    | | location_id<br />_(required)_         | `string`  | The location where the member works. The identifier comes from the response when creating a `Group`. | | retiree<br />_(required)_             | `boolean` |                                                                                                      | | zip_code<br />_(required)_            | `string`  |                                                                                                      | ##### Dependents The `dependents` key is a required list containing each `Dependent` the `Member` has. If the `Member` has no dependents, an empty list should be passed.  | Field                                 | Type      | Notes                                                                                                     | |---------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------| | date_of_birth<br />_(required)_       | `string`  | The format is `YYYY-MM-DD`. Dependents cannot be less than 0 years old at the time of quoting.            | | gender<br />_(required)_              | `string`  | The options are `M` or `F`.                                                                               | | last_used_tobacco<br />_(required)_   | `string`  | The format is `YYYY-MM-DD`. For those that have never smoked, please pass `null`.                         | | relationship<br />_(required)_        | `string`  | Please see the [Overview Section](#header-dependent-relationships) for a list of allowed relationships.   | | same_household<br />_(required)_      | `boolean` | Does the dependent live in the same household as the member?                                              |
 
 ### Example
 ```ruby
@@ -314,7 +314,8 @@ body = VericredClient::MembersCreateRequest.new # MembersCreateRequest |
 
 begin
   #Create or Update Members
-  api_instance.update_group_members(id, body)
+  result = api_instance.update_group_members(id, body)
+  p result
 rescue VericredClient::ApiError => e
   puts "Exception when calling QuotingApi->update_group_members: #{e}"
 end
@@ -329,7 +330,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-nil (empty response body)
+[**MembersCreateResponse**](MembersCreateResponse.md)
 
 ### Authorization