vericred_client 0.0.11 → 0.0.18

data/docs/RatesApi.md

@@ -0,0 +1,119 @@
+# VericredClient::RatesApi
+
+All URIs are relative to *https://api.vericred.com/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_rate**](RatesApi.md#delete_rate) | **DELETE** /rates/{vericred_id} | Delete a Rate.
+[**put_rate**](RatesApi.md#put_rate) | **PUT** /rates/{vericred_id} | Create/update a Rate
+
+
+# **delete_rate**
+> delete_rate(vericred_id)
+
+Delete a Rate.
+
+Delete a Rate from the database.
+
+### 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::RatesApi.new
+
+vericred_id = "a234567b90" # String | The unique Vericred id
+
+
+begin
+  #Delete a Rate.
+  api_instance.delete_rate(vericred_id)
+rescue VericredClient::ApiError => e
+  puts "Exception when calling RatesApi->delete_rate: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vericred_id** | **String**| The unique Vericred id | 
+
+### 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
+
+
+
+# **put_rate**
+> put_rate(vericred_id, body)
+
+Create/update a Rate
+
+Add or update a Rate to the database.
+
+### 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::RatesApi.new
+
+vericred_id = "a234567b90" # String | The unique Vericred id
+
+body = VericredClient::RateRequest.new # RateRequest | Rate Record
+
+
+begin
+  #Create/update a Rate
+  api_instance.put_rate(vericred_id, body)
+rescue VericredClient::ApiError => e
+  puts "Exception when calling RatesApi->put_rate: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vericred_id** | **String**| The unique Vericred id | 
+ **body** | [**RateRequest**](RateRequest.md)| Rate Record | 
+
+### 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
+
+
+

data/docs/RequestPlanFind.md

@@ -4,9 +4,11 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **applicants** | [**Array<RequestPlanFindApplicant>**](RequestPlanFindApplicant.md) | Applicants for desired plans. | [optional] 
+**carrier_id** | **Integer** | National-level carrier id | [optional] 
 **enrollment_date** | **String** | Date of enrollment | [optional] 
 **drug_packages** | [**Array<RequestPlanFindDrugPackage>**](RequestPlanFindDrugPackage.md) | National Drug Code Package Id | [optional] 
 **fips_code** | **String** | County code to determine eligibility | [optional] 
+**group_name** | **String** | Label for search tracking | [optional] 
 **household_income** | **Integer** | Total household income. | [optional] 
 **household_size** | **Integer** | Number of people living in household. | [optional] 
 **ids** | **Array<Integer>** | List of plan IDs to filter by | [optional] 

data/docs/RequestPlanFindCarrierVerification.md

@@ -0,0 +1,23 @@
+# VericredClient::RequestPlanFindCarrierVerification
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**applicants** | [**Array<RequestPlanFindApplicant>**](RequestPlanFindApplicant.md) | Applicants for desired plans. | [optional] 
+**carrier_id** | **Integer** | National-level carrier id | [optional] 
+**enrollment_date** | **String** | Date of enrollment | [optional] 
+**drug_packages** | [**Array<RequestPlanFindDrugPackage>**](RequestPlanFindDrugPackage.md) | National Drug Code Package Id | [optional] 
+**fips_code** | **String** | County code to determine eligibility | [optional] 
+**group_name** | **String** | Label for search tracking | [optional] 
+**household_income** | **Integer** | Total household income. | [optional] 
+**household_size** | **Integer** | Number of people living in household. | [optional] 
+**ids** | **Array<Integer>** | List of plan IDs to filter by | [optional] 
+**market** | **String** | Type of plan to search for. | [optional] 
+**providers** | [**Array<RequestPlanFindProvider>**](RequestPlanFindProvider.md) | List of providers to search for. | [optional] 
+**page** | **Integer** | Selected page of paginated response. | [optional] 
+**per_page** | **Integer** | Results per page of response. | [optional] 
+**sort** | **String** | Sort responses by plan field. | [optional] 
+**zip_code** | **String** | 5-digit zip code - this helps determine pricing. | [optional] 
+**issuer_vericred_ids** | **Array<String>** | Vericred IDs of the issuers to include in search | [optional] 
+
+

data/docs/RequestProviderNotificationSubscription.md

@@ -0,0 +1,10 @@
+# VericredClient::RequestProviderNotificationSubscription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**npis** | **Array<String>** | National Provider Index (NPI) numbers for providers. | [optional] 
+**plan_id** | **String** | The plan ID to watch for provider events. | [optional] 
+**callback_url** | **String** | The URL where notifications should be sent. | [optional] 
+
+

data/docs/RequestProvidersSearch.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **accepts_insurance** | **BOOLEAN** | 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 | [optional] 
+**ids** | **Array<Integer>** | List of NPIs | [optional] 
 **min_score** | **Float** | Minimum search threshold to be included in the results | [optional] 
 **network_ids** | **Array<Integer>** | List of Vericred network ids | [optional] 
 **page** | **Integer** | Page number | [optional] 

data/docs/RequestRatesSearch.md

@@ -0,0 +1,10 @@
+# VericredClient::RequestRatesSearch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enrollment_date** | **Date** | Date on which the plan is effective | [optional] 
+**zip_code** | **String** | Zip code in which the plan is offered | [optional] 
+**fips_code** | **String** | Fips code in which the plan is offered | [optional] 
+
+

data/docs/ResponseRatesSearch.md

@@ -0,0 +1,8 @@
+# VericredClient::ResponseRatesSearch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rate** | [**RateSearch**](RateSearch.md) | Rate data | [optional] 
+
+

data/docs/RxCuiIdentifier.md

@@ -0,0 +1,11 @@
+# VericredClient::RxCuiIdentifier
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Primary key | [optional] 
+**name** | **String** | Human-readable name | [optional] 
+**med_id** | **Integer** | Foreign key to Meds (can be nil) | [optional] 
+**rx_cui_id** | **String** | Foreign key to Rx-Norm | [optional] 
+
+

data/docs/RxCuiIdentifierSearchResponse.md

@@ -0,0 +1,9 @@
+# VericredClient::RxCuiIdentifierSearchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Meta**](Meta.md) | Meta-data | [optional] 
+**drugs** | [**Array<RxCuiIdentifier>**](RxCuiIdentifier.md) | Drugs found in query | [optional] 
+
+

data/docs/VisionPlan.md

@@ -0,0 +1,20 @@
+# VericredClient::VisionPlan
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The vision plan identifier | [optional] 
+**name** | **String** | The vision plan name | [optional] 
+**issuer_name** | **String** | Name of the insurance carrier | [optional] 
+**audience** | **String** | The vision plan audience | [optional] 
+**benefits_summary_url** | **String** | Link to the summary of benefits and coverage (SBC) document. | [optional] 
+**logo_url** | **String** | Link to a copy of the insurance carrier's logo | [optional] 
+**plan_type** | **String** | Category of the plan (e.g. EPO, HMO, PPO, POS, Indemnity, PACE,HMO w/POS, Cost, FFS, MSA) | [optional] 
+**stand_alone** | **BOOLEAN** | Stand alone flag for vision plan | [optional] 
+**source** | **String** | Source of the plan benefit data | [optional] 
+**identifiers** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | List of identifiers of this Plan | [optional] 
+**benefits** | [**VisionPlanBenefits**](VisionPlanBenefits.md) | Vision Plan Benefits | [optional] 
+**premium** | **Float** | Cumulative premium amount | [optional] 
+**premium_source** | **String** | Source of the base pricing data | [optional] 
+
+

data/docs/VisionPlanBenefits.md

@@ -0,0 +1,25 @@
+# VericredClient::VisionPlanBenefits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**individual_deductible** | **String** | Individual Deductible benefit string | [optional] 
+**family_deductible** | **String** | Family Deductible benefit string | [optional] 
+**individual_annual_max** | **String** | Individual Annual Max benefit string | [optional] 
+**family_max_annual_max** | **String** | Family Max Annual Max benefit string | [optional] 
+**individual_moop** | **String** | Individual MOOP benefit string | [optional] 
+**family_moop** | **String** | Family MOOP benefit string | [optional] 
+**eye_exam** | **String** | Eye Exam benefit string | [optional] 
+**frame** | **String** | Frame benefit string | [optional] 
+**contacts** | **String** | Contacts benefit string | [optional] 
+**laser_vision_correction** | **String** | Laser Vision Correction benefit string | [optional] 
+**progressive_lenses** | **String** | Progressive Lenses benefit string | [optional] 
+**uv_lenses** | **String** | UV Lenses benefit string | [optional] 
+**scratch_resistant_coating** | **String** | Scratch-Resistant Coating benefit string | [optional] 
+**antireflective_coating** | **String** | Antireflective Coating benefit string | [optional] 
+**photochromatic_single_vision** | **String** | Photochromatic - Single Vision benefit string | [optional] 
+**photochromatic_multifocal** | **String** | Photochromatic - Mutlifocal benefit string | [optional] 
+**polychromatic_single_vision** | **String** | Polychromatic - Single Vision benefit string | [optional] 
+**polychromatic_multifocal** | **String** | Polychromatic - Mutlifocal benefit string | [optional] 
+
+

data/docs/VisionPlanSearchApplicant.md

@@ -0,0 +1,10 @@
+# VericredClient::VisionPlanSearchApplicant
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**age** | **Integer** | Age of applicant to search for | [optional] 
+**child** | **BOOLEAN** | Is this applicant a child? | [optional] 
+**gender** | **String** | Applicant's gender (M or F) | [optional] 
+
+

data/docs/VisionPlanSearchRequest.md

@@ -0,0 +1,15 @@
+# VericredClient::VisionPlanSearchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**applicants** | [**Array<VisionPlanSearchApplicant>**](VisionPlanSearchApplicant.md) | Applicants for desired plans. | [optional] 
+**issuer_id** | **Integer** | National-level issuer id | [optional] 
+**enrollment_date** | **String** | Date of enrollment | [optional] 
+**fips_code** | **String** | County code to determine eligibility | [optional] 
+**zip_code** | **String** | 5-digit zip code - this helps determine pricing. | [optional] 
+**market** | **String** | The audience of plan to search for. Possible values are individual, shop, small_group, medicare_advantage | [optional] 
+**page** | **Integer** | Selected page of paginated response. | [optional] 
+**per_page** | **Integer** | Results per page of response. | [optional] 
+
+

data/docs/VisionPlanSearchResponse.md

@@ -0,0 +1,9 @@
+# VericredClient::VisionPlanSearchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Meta**](Meta.md) | Meta-data | [optional] 
+**plans** | [**Array<VisionPlan>**](VisionPlan.md) | Vision plan search results | [optional] 
+
+

data/docs/VisionPlanShowResponse.md

@@ -0,0 +1,8 @@
+# VericredClient::VisionPlanShowResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**vision_plan** | [**VisionPlan**](VisionPlan.md) | Vision Plan response | [optional] 
+
+

data/docs/VisionPlanUpdate.md

@@ -0,0 +1,16 @@
+# VericredClient::VisionPlanUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The vision plan name | [optional] 
+**issuer_vericred_id** | **String** | The issuer vericred id | [optional] 
+**audience** | **String** | The vision plan audience | [optional] 
+**benefits_summary_url** | **String** | Link to the summary of benefits and coverage (SBC) document. | [optional] 
+**plan_type** | **String** | The vision plan type | [optional] 
+**stand_alone** | **BOOLEAN** | Stand alone flag for vision plan | [optional] 
+**source** | **String** | The vision plan source | [optional] 
+**external_ids** | [**Array<PlanIdentifier>**](PlanIdentifier.md) | Vision Plan External Identifiers | [optional] 
+**benefits** | [**VisionPlanBenefits**](VisionPlanBenefits.md) | Vision Plan Benefits | [optional] 
+
+

data/docs/VisionPlanUpdateRequest.md

@@ -0,0 +1,8 @@
+# VericredClient::VisionPlanUpdateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**vision_plan** | [**VisionPlanUpdate**](VisionPlanUpdate.md) | Vision Plan | [optional] 
+
+

data/docs/VisionPlansApi.md

@@ -0,0 +1,174 @@
+# VericredClient::VisionPlansApi
+
+All URIs are relative to *https://api.vericred.com/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_vision_plan**](VisionPlansApi.md#delete_vision_plan) | **DELETE** /plans/vision/{vericred_id} | Delete a Vision Plan.
+[**put_vision_plan**](VisionPlansApi.md#put_vision_plan) | **PUT** /plans/vision/{vericred_id} | Create/update a Vision Plan
+[**show_vision_plan**](VisionPlansApi.md#show_vision_plan) | **GET** /plans/vision/{vericred_id} | Show Plan
+
+
+# **delete_vision_plan**
+> delete_vision_plan(vericred_id)
+
+Delete a Vision Plan.
+
+Delete a Vision Plan from the database.
+
+### 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::VisionPlansApi.new
+
+vericred_id = "a234567b90" # String | The unique Vericred id
+
+
+begin
+  #Delete a Vision Plan.
+  api_instance.delete_vision_plan(vericred_id)
+rescue VericredClient::ApiError => e
+  puts "Exception when calling VisionPlansApi->delete_vision_plan: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vericred_id** | **String**| The unique Vericred id | 
+
+### 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
+
+
+
+# **put_vision_plan**
+> put_vision_plan(vericred_id, body)
+
+Create/update a Vision Plan
+
+Add or update a Vision Plan to the database.
+
+### 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::VisionPlansApi.new
+
+vericred_id = "a234567b90" # String | The unique Vericred id
+
+body = VericredClient::VisionPlanUpdateRequest.new # VisionPlanUpdateRequest | Vision Plan Record
+
+
+begin
+  #Create/update a Vision Plan
+  api_instance.put_vision_plan(vericred_id, body)
+rescue VericredClient::ApiError => e
+  puts "Exception when calling VisionPlansApi->put_vision_plan: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vericred_id** | **String**| The unique Vericred id | 
+ **body** | [**VisionPlanUpdateRequest**](VisionPlanUpdateRequest.md)| Vision Plan Record | 
+
+### 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
+
+
+
+# **show_vision_plan**
+> VisionPlanShowResponse show_vision_plan(id)
+
+Show Plan
+
+Show the details of a VisionPlan.
+
+### 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::VisionPlansApi.new
+
+id = "88582NY0230001" # String | ID of the Plan
+
+
+begin
+  #Show Plan
+  result = api_instance.show_vision_plan(id)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling VisionPlansApi->show_vision_plan: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the Plan | 
+
+### Return type
+
+[**VisionPlanShowResponse**](VisionPlanShowResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+