class VericredClient::QuotingApi
Attributes
Public Class Methods
# File lib/vericred_client/api/quoting_api.rb, line 1018 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a Group 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` | | @param body @param [Hash] opts the optional parameters @return [GroupCreateResponse]
# File lib/vericred_client/api/quoting_api.rb, line 1027 def create_group(body, opts = {}) data, _status_code, _headers = create_group_with_http_info(body, opts) return data end
Create a Quote 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`, `2_tier_composite`, and `adult_child_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. | @param id ID of the Group @param [Hash] opts the optional parameters @option opts [QuoteCreateRequest] :body @return [QuoteCreateResponse]
# File lib/vericred_client/api/quoting_api.rb, line 1085 def create_group_quote(id, opts = {}) data, _status_code, _headers = create_group_quote_with_http_info(id, opts) return data end
Create a Quote 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`, `2_tier_composite`, and `adult_child_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. | @param id ID of the Group @param [Hash] opts the optional parameters @option opts [QuoteCreateRequest] :body @return [Array<(QuoteCreateResponse
, Fixnum, Hash)>] QuoteCreateResponse
data, response status code and response headers
# File lib/vericred_client/api/quoting_api.rb, line 1096 def create_group_quote_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: QuotingApi.create_group_quote ..." end # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling QuotingApi.create_group_quote" if id.nil? # resource path local_var_path = "/groups/{id}/quotes".sub('{format}','json').sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['Vericred-Api-Key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'QuoteCreateResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: QuotingApi#create_group_quote\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create a Group 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` | | @param body @param [Hash] opts the optional parameters @return [Array<(GroupCreateResponse
, Fixnum, Hash)>] GroupCreateResponse
data, response status code and response headers
# File lib/vericred_client/api/quoting_api.rb, line 1037 def create_group_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: QuotingApi.create_group ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling QuotingApi.create_group" if body.nil? # resource path local_var_path = "/groups".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['Vericred-Api-Key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GroupCreateResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: QuotingApi#create_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Display a Group Retrieve the details for a `Group` @param id ID of the Group @param [Hash] opts the optional parameters @return [GroupShowResponse]
# File lib/vericred_client/api/quoting_api.rb, line 1143 def show_group(id, opts = {}) data, _status_code, _headers = show_group_with_http_info(id, opts) return data end
Display Rates Retrieve the rates for a `Quote`. The `source` key shows the source from which we received the rates. The possible values are detailed below. | Source Value | Notes | | ———— | —————————————————————————————————- | | `carrier` | The rates were received from a carrier. | | `state` | The rates originate from state filings. | | `cms` | The rates originate from Centers for Medicare & Medicaid Services (CMS) filings. | | `null` | Only `Quote`s generated before the release of this key (2019-09-10) will contain null source values. | The `premiums` key contains the available rating methods we have for the each plan. The rating methods are detailed below. | Premiums
Key | Notes | |—————————-|——————————————————————————————————————————————————————————| | age_banded | The keys include `total_member`, `total_dependent`, and `total`. The values are the sums. | | 4_tier_composite | The keys include `employee_only`, `employee_plus_spouse`, `employee_plus_children`, `employee_plus_family`, and `total`. The values are the per-member rate for each bucket. | | 3_tier_composite | The keys include `employee_only`, `employee_plus_one`, `employee_plus_family`, and `total`. The values are the per-member rate for each bucket. | | 2_tier_composite | The keys include `employee_only`, `employee_plus_family`, and `total`. The values are the per-member rate for each bucket. | | adult_child_tier_composite | The keys include `adult`, `child`, and `total`. The values are the per-member rate for each bucket. | 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. @param id ID of the quote @param [Hash] opts the optional parameters @option opts [Integer] :page Page of paginated response @option opts [Integer] :per_page Responses per page @return [RatesShowResponse]
# File lib/vericred_client/api/quoting_api.rb, line 1202 def show_group_rates(id, opts = {}) data, _status_code, _headers = show_group_rates_with_http_info(id, opts) return data end
Display Rates Retrieve the rates for a `Quote`. The `source` key shows the source from which we received the rates. The possible values are detailed below. | Source Value | Notes | | ———— | —————————————————————————————————- | | `carrier` | The rates were received from a carrier. | | `state` | The rates originate from state filings. | | `cms` | The rates originate from Centers for Medicare & Medicaid Services (CMS) filings. | | `null` | Only `Quote`s generated before the release of this key (2019-09-10) will contain null source values. | The `premiums` key contains the available rating methods we have for the each plan. The rating methods are detailed below. | Premiums
Key | Notes | |—————————-|——————————————————————————————————————————————————————————| | age_banded | The keys include `total_member`, `total_dependent`, and `total`. The values are the sums. | | 4_tier_composite | The keys include `employee_only`, `employee_plus_spouse`, `employee_plus_children`, `employee_plus_family`, and `total`. The values are the per-member rate for each bucket. | | 3_tier_composite | The keys include `employee_only`, `employee_plus_one`, `employee_plus_family`, and `total`. The values are the per-member rate for each bucket. | | 2_tier_composite | The keys include `employee_only`, `employee_plus_family`, and `total`. The values are the per-member rate for each bucket. | | adult_child_tier_composite | The keys include `adult`, `child`, and `total`. The values are the per-member rate for each bucket. | 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. @param id ID of the quote @param [Hash] opts the optional parameters @option opts [Integer] :page Page of paginated response @option opts [Integer] :per_page Responses per page @return [Array<(RatesShowResponse
, Fixnum, Hash)>] RatesShowResponse
data, response status code and response headers
# File lib/vericred_client/api/quoting_api.rb, line 1214 def show_group_rates_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: QuotingApi.show_group_rates ..." end # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling QuotingApi.show_group_rates" if id.nil? # resource path local_var_path = "/quotes/{id}/rates".sub('{format}','json').sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['Vericred-Api-Key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RatesShowResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: QuotingApi#show_group_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Display a Group Retrieve the details for a `Group` @param id ID of the Group @param [Hash] opts the optional parameters @return [Array<(GroupShowResponse
, Fixnum, Hash)>] GroupShowResponse
data, response status code and response headers
# File lib/vericred_client/api/quoting_api.rb, line 1153 def show_group_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: QuotingApi.show_group ..." end # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling QuotingApi.show_group" if id.nil? # resource path local_var_path = "/groups/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['Vericred-Api-Key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GroupShowResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: QuotingApi#show_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Display Member Rates Retrieve the member-level rates for a particular `Rate` returned for a `Quote`. The `premiums` key contains the available rating methods we have for the `Rate`, along with the member-specific rates for each method. For composite methods, the category the member falls into is shown. @param id ID of the Rate @param [Hash] opts the optional parameters @return [MemberRatesShowResponse]
# File lib/vericred_client/api/quoting_api.rb, line 1263 def show_rate_member_rates(id, opts = {}) data, _status_code, _headers = show_rate_member_rates_with_http_info(id, opts) return data end
Display Member Rates Retrieve the member-level rates for a particular `Rate` returned for a `Quote`. The `premiums` key contains the available rating methods we have for the `Rate`, along with the member-specific rates for each method. For composite methods, the category the member falls into is shown. @param id ID of the Rate @param [Hash] opts the optional parameters @return [Array<(MemberRatesShowResponse
, Fixnum, Hash)>] MemberRatesShowResponse
data, response status code and response headers
# File lib/vericred_client/api/quoting_api.rb, line 1273 def show_rate_member_rates_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: QuotingApi.show_rate_member_rates ..." end # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling QuotingApi.show_rate_member_rates" if id.nil? # resource path local_var_path = "/rates/{id}/member_rates".sub('{format}','json').sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['Vericred-Api-Key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'MemberRatesShowResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: QuotingApi#show_rate_member_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create or Update Members 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? | @param id ID of the Group @param body @param [Hash] opts the optional parameters @return [MembersCreateResponse]
# File lib/vericred_client/api/quoting_api.rb, line 1321 def update_group_members(id, body, opts = {}) data, _status_code, _headers = update_group_members_with_http_info(id, body, opts) return data end
Create or Update Members 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? | @param id ID of the Group @param body @param [Hash] opts the optional parameters @return [Array<(MembersCreateResponse
, Fixnum, Hash)>] MembersCreateResponse
data, response status code and response headers
# File lib/vericred_client/api/quoting_api.rb, line 1332 def update_group_members_with_http_info(id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: QuotingApi.update_group_members ..." end # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling QuotingApi.update_group_members" if id.nil? # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling QuotingApi.update_group_members" if body.nil? # resource path local_var_path = "/groups/{id}/members".sub('{format}','json').sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['Vericred-Api-Key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'MembersCreateResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: QuotingApi#update_group_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end