vericred_client 0.0.23 → 0.0.25

data/docs/QuoteCreate.md

@@ -0,0 +1,15 @@
+# VericredClient::QuoteCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_ids** | **Array<String>** | null | [optional] 
+**contribution_percentage** | **Integer** | null | [optional] 
+**effective_date** | **Date** | null | [optional] 
+**npn** | **String** | null | [optional] 
+**participation_percentage** | **Integer** | null | [optional] 
+**product_line** | **String** | null | [optional] 
+**rating_method** | **String** | null | [optional] 
+**voluntary** | **BOOLEAN** | null | [optional] 
+
+

data/docs/QuoteCreateRequest.md

@@ -0,0 +1,8 @@
+# VericredClient::QuoteCreateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quote** | [**QuoteCreate**](QuoteCreate.md) | Quote Attributes | [optional] 
+
+

data/docs/QuoteCreateResponse.md

@@ -0,0 +1,8 @@
+# VericredClient::QuoteCreateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quote** | [**QuoteShow**](QuoteShow.md) | Quote Attributes | [optional] 
+
+

data/docs/QuoteShow.md

@@ -0,0 +1,17 @@
+# VericredClient::QuoteShow
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_ids** | **Array<String>** | null | [optional] 
+**contribution_percentage** | **Integer** | null | [optional] 
+**created_at** | **Date** | null | [optional] 
+**effective_date** | **Date** | null | [optional] 
+**id** | **String** | null | [optional] 
+**npn** | **String** | null | [optional] 
+**participation_percentage** | **Integer** | null | [optional] 
+**product_line** | **String** | null | [optional] 
+**rating_method** | **String** | null | [optional] 
+**voluntary** | **BOOLEAN** | null | [optional] 
+
+

data/docs/QuoteShowResponse.md

@@ -0,0 +1,8 @@
+# VericredClient::QuoteShowResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quote** | [**QuoteShow**](QuoteShow.md) | Quote Attributes | [optional] 
+
+

data/docs/QuotingApi.md

@@ -0,0 +1,344 @@
+# VericredClient::QuotingApi
+
+All URIs are relative to *https://api.vericred.com/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_group**](QuotingApi.md#create_group) | **POST** /groups | Create a Group
+[**create_group_quote**](QuotingApi.md#create_group_quote) | **POST** /groups/{id}/quotes | Create a Quote
+[**show_group**](QuotingApi.md#show_group) | **GET** /groups/{id} | Display a Group
+[**show_group_rates**](QuotingApi.md#show_group_rates) | **GET** /quotes/{id}/rates | Display Rates
+[**show_rate_member_rates**](QuotingApi.md#show_rate_member_rates) | **GET** /rates/{id}/member_rates | Display Member Rates
+[**update_group_members**](QuotingApi.md#update_group_members) | **PUT** /groups/{id}/members | Create or Update Members
+
+
+# **create_group**
+> GroupCreateResponse create_group(body)
+
+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)
+
+### 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::QuotingApi.new
+
+body = VericredClient::GroupCreateRequest.new # GroupCreateRequest | 
+
+
+begin
+  #Create a Group
+  result = api_instance.create_group(body)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling QuotingApi->create_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**GroupCreateRequest**](GroupCreateRequest.md)|  | 
+
+### Return type
+
+[**GroupCreateResponse**](GroupCreateResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_group_quote**
+> QuoteCreateResponse create_group_quote(id, opts)
+
+Create a Quote
+
+Generate a `Quote` for a `Group`
+
+### 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::QuotingApi.new
+
+id = "b215b6bcdb" # String | ID of the Group
+
+opts = { 
+  body: VericredClient::QuoteCreateRequest.new # QuoteCreateRequest | 
+}
+
+begin
+  #Create a Quote
+  result = api_instance.create_group_quote(id, opts)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling QuotingApi->create_group_quote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the Group | 
+ **body** | [**QuoteCreateRequest**](QuoteCreateRequest.md)|  | [optional] 
+
+### Return type
+
+[**QuoteCreateResponse**](QuoteCreateResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **show_group**
+> GroupShowResponse show_group(id)
+
+Display a Group
+
+Retrieve the details for a `Group`
+
+### 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::QuotingApi.new
+
+id = "b215b6bcdb" # String | ID of the Group
+
+
+begin
+  #Display a Group
+  result = api_instance.show_group(id)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling QuotingApi->show_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the Group | 
+
+### Return type
+
+[**GroupShowResponse**](GroupShowResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **show_group_rates**
+> RatesShowResponse show_group_rates(id)
+
+Display Rates
+
+null
+
+### 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::QuotingApi.new
+
+id = "5db8ce543d" # String | ID of the quote
+
+
+begin
+  #Display Rates
+  result = api_instance.show_group_rates(id)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling QuotingApi->show_group_rates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the quote | 
+
+### Return type
+
+[**RatesShowResponse**](RatesShowResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **show_rate_member_rates**
+> MemberRatesShowResponse show_rate_member_rates(id)
+
+Display Member Rates
+
+null
+
+### 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::QuotingApi.new
+
+id = "bb1f3523f0" # String | ID of the Rate
+
+
+begin
+  #Display Member Rates
+  result = api_instance.show_rate_member_rates(id)
+  p result
+rescue VericredClient::ApiError => e
+  puts "Exception when calling QuotingApi->show_rate_member_rates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the Rate | 
+
+### Return type
+
+[**MemberRatesShowResponse**](MemberRatesShowResponse.md)
+
+### Authorization
+
+[Vericred-Api-Key](../README.md#Vericred-Api-Key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_group_members**
+> update_group_members(id, body)
+
+Create or Update Members
+
+Specify the `Member`s and `Dependent`s for the `Group`
+
+### 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::QuotingApi.new
+
+id = "b215b6bcdb" # String | ID of the Group
+
+body = VericredClient::MembersCreateRequest.new # MembersCreateRequest | 
+
+
+begin
+  #Create or Update Members
+  api_instance.update_group_members(id, body)
+rescue VericredClient::ApiError => e
+  puts "Exception when calling QuotingApi->update_group_members: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the Group | 
+ **body** | [**MembersCreateRequest**](MembersCreateRequest.md)|  | 
+
+### 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/RateRequest.md

@@ -3,30 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**external_id** | **String** | The external id of the plan | [optional] 
-**effective_date** | **String** | The effective date of the rate | [optional] 
-**expiration_date** | **String** | The expiration date of the rate | [optional] 
-**rating_area_natural_key** | **String** | The natural key for the rating area of the  rate | [optional] 
 **age_0** | **Float** | The age 0 non-tobacco rate for the plan | [optional] 
 **age_0_tobacco** | **Float** | The age 0 tobacco rate for the plan | [optional] 
 **age_1** | **Float** | The age 1 non-tobacco rate for the plan | [optional] 
-**age_1_tobacco** | **Float** | The age 1 tobacco rate for the plan | [optional] 
-**age_2** | **Float** | The age 2 non-tobacco rate for the plan | [optional] 
-**age_2_tobacco** | **Float** | The age 2 tobacco rate for the plan | [optional] 
-**age_3** | **Float** | The age 3 non-tobacco rate for the plan | [optional] 
-**age_3_tobacco** | **Float** | The age 3 tobacco rate for the plan | [optional] 
-**age_4** | **Float** | The age 4 non-tobacco rate for the plan | [optional] 
-**age_4_tobacco** | **Float** | The age 4 tobacco rate for the plan | [optional] 
-**age_5** | **Float** | The age 5 non-tobacco rate for the plan | [optional] 
-**age_5_tobacco** | **Float** | The age 5 tobacco rate for the plan | [optional] 
-**age_6** | **Float** | The age 6 non-tobacco rate for the plan | [optional] 
-**age_6_tobacco** | **Float** | The age 6 tobacco rate for the plan | [optional] 
-**age_7** | **Float** | The age 7 non-tobacco rate for the plan | [optional] 
-**age_7_tobacco** | **Float** | The age 7 tobacco rate for the plan | [optional] 
-**age_8** | **Float** | The age 8 non-tobacco rate for the plan | [optional] 
-**age_8_tobacco** | **Float** | The age 8 tobacco rate for the plan | [optional] 
-**age_9** | **Float** | The age 9 non-tobacco rate for the plan | [optional] 
-**age_9_tobacco** | **Float** | The age 9 tobacco rate for the plan | [optional] 
 **age_10** | **Float** | The age 10 non-tobacco rate for the plan | [optional] 
 **age_10_tobacco** | **Float** | The age 10 tobacco rate for the plan | [optional] 
 **age_11** | **Float** | The age 11 non-tobacco rate for the plan | [optional] 
@@ -47,6 +26,8 @@ Name | Type | Description | Notes
 **age_18_tobacco** | **Float** | The age 18 tobacco rate for the plan | [optional] 
 **age_19** | **Float** | The age 19 non-tobacco rate for the plan | [optional] 
 **age_19_tobacco** | **Float** | The age 19 tobacco rate for the plan | [optional] 
+**age_1_tobacco** | **Float** | The age 1 tobacco rate for the plan | [optional] 
+**age_2** | **Float** | The age 2 non-tobacco rate for the plan | [optional] 
 **age_20** | **Float** | The age 20 non-tobacco rate for the plan | [optional] 
 **age_20_tobacco** | **Float** | The age 20 tobacco rate for the plan | [optional] 
 **age_21** | **Float** | The age 21 non-tobacco rate for the plan | [optional] 
@@ -67,6 +48,8 @@ Name | Type | Description | Notes
 **age_28_tobacco** | **Float** | The age 28 tobacco rate for the plan | [optional] 
 **age_29** | **Float** | The age 29 non-tobacco rate for the plan | [optional] 
 **age_29_tobacco** | **Float** | The age 29 tobacco rate for the plan | [optional] 
+**age_2_tobacco** | **Float** | The age 2 tobacco rate for the plan | [optional] 
+**age_3** | **Float** | The age 3 non-tobacco rate for the plan | [optional] 
 **age_30** | **Float** | The age 30 non-tobacco rate for the plan | [optional] 
 **age_30_tobacco** | **Float** | The age 30 tobacco rate for the plan | [optional] 
 **age_31** | **Float** | The age 31 non-tobacco rate for the plan | [optional] 
@@ -87,6 +70,8 @@ Name | Type | Description | Notes
 **age_38_tobacco** | **Float** | The age 38 tobacco rate for the plan | [optional] 
 **age_39** | **Float** | The age 39 non-tobacco rate for the plan | [optional] 
 **age_39_tobacco** | **Float** | The age 39 tobacco rate for the plan | [optional] 
+**age_3_tobacco** | **Float** | The age 3 tobacco rate for the plan | [optional] 
+**age_4** | **Float** | The age 4 non-tobacco rate for the plan | [optional] 
 **age_40** | **Float** | The age 40 non-tobacco rate for the plan | [optional] 
 **age_40_tobacco** | **Float** | The age 40 tobacco rate for the plan | [optional] 
 **age_41** | **Float** | The age 41 non-tobacco rate for the plan | [optional] 
@@ -107,6 +92,8 @@ Name | Type | Description | Notes
 **age_48_tobacco** | **Float** | The age 48 tobacco rate for the plan | [optional] 
 **age_49** | **Float** | The age 49 non-tobacco rate for the plan | [optional] 
 **age_49_tobacco** | **Float** | The age 49 tobacco rate for the plan | [optional] 
+**age_4_tobacco** | **Float** | The age 4 tobacco rate for the plan | [optional] 
+**age_5** | **Float** | The age 5 non-tobacco rate for the plan | [optional] 
 **age_50** | **Float** | The age 50 non-tobacco rate for the plan | [optional] 
 **age_50_tobacco** | **Float** | The age 50 tobacco rate for the plan | [optional] 
 **age_51** | **Float** | The age 51 non-tobacco rate for the plan | [optional] 
@@ -127,6 +114,8 @@ Name | Type | Description | Notes
 **age_58_tobacco** | **Float** | The age 58 tobacco rate for the plan | [optional] 
 **age_59** | **Float** | The age 59 non-tobacco rate for the plan | [optional] 
 **age_59_tobacco** | **Float** | The age 59 tobacco rate for the plan | [optional] 
+**age_5_tobacco** | **Float** | The age 5 tobacco rate for the plan | [optional] 
+**age_6** | **Float** | The age 6 non-tobacco rate for the plan | [optional] 
 **age_60** | **Float** | The age 60 non-tobacco rate for the plan | [optional] 
 **age_60_tobacco** | **Float** | The age 60 tobacco rate for the plan | [optional] 
 **age_61** | **Float** | The age 61 non-tobacco rate for the plan | [optional] 
@@ -139,11 +128,22 @@ Name | Type | Description | Notes
 **age_64_tobacco** | **Float** | The age 64 tobacco rate for the plan | [optional] 
 **age_65** | **Float** | The age 65 non-tobacco rate for the plan | [optional] 
 **age_65_tobacco** | **Float** | The age 65 tobacco rate for the plan | [optional] 
+**age_6_tobacco** | **Float** | The age 6 tobacco rate for the plan | [optional] 
+**age_7** | **Float** | The age 7 non-tobacco rate for the plan | [optional] 
+**age_7_tobacco** | **Float** | The age 7 tobacco rate for the plan | [optional] 
+**age_8** | **Float** | The age 8 non-tobacco rate for the plan | [optional] 
+**age_8_tobacco** | **Float** | The age 8 tobacco rate for the plan | [optional] 
+**age_9** | **Float** | The age 9 non-tobacco rate for the plan | [optional] 
+**age_9_tobacco** | **Float** | The age 9 tobacco rate for the plan | [optional] 
+**child_only** | **Float** | The tier child_only rate for the plan | [optional] 
+**effective_date** | **String** | The effective date of the rate | [optional] 
+**expiration_date** | **String** | The expiration date of the rate | [optional] 
+**external_id** | **String** | The external id of the plan | [optional] 
+**family** | **Float** | The tier family rate for the plan | [optional] 
+**rating_area_natural_key** | **String** | The natural key for the rating area of the  rate | [optional] 
 **single** | **Float** | The tier single rate for the plan | [optional] 
-**single_and_spouse** | **Float** | The tier single_and_spouse rate for the plan | [optional] 
 **single_and_children** | **Float** | The tier single_and_children rate for the plan | [optional] 
-**family** | **Float** | The tier family rate for the plan | [optional] 
-**child_only** | **Float** | The tier child_only rate for the plan | [optional] 
+**single_and_spouse** | **Float** | The tier single_and_spouse rate for the plan | [optional] 
 **source** | **String** | The document source type of the rate | [optional]