Class: VericredClient::QuotingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vericred_client/api/quoting_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ QuotingApi

Returns a new instance of QuotingApi.



1018
1019
1020
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1018

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



1016
1017
1018
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1016

def api_client
  @api_client
end

Instance Method Details

#create_group(body, opts = {}) ⇒ GroupCreateResponse

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` | |

Parameters:

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1027
1028
1029
1030
 
# 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_group_quote(id, opts = {}) ⇒ QuoteCreateResponse

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. |

Parameters:

  • id —

    ID of the Group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1085
1086
1087
1088
 
# 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_group_quote_with_http_info(id, opts = {}) ⇒ Array<(QuoteCreateResponse, Fixnum, Hash)>

Create a Quote Generate a &#x60;Quote&#x60; for a &#x60;Group&#x60;. See the [Overview Section](#quoting-quoting-post-1) for more information. ### Parameters #### Quote _(required)_ The &#x60;quote&#x60; key is required and it contains the criteria below for the quote that is being generated. | Field | Type | Notes | |——————————————–|———–|———————————————————————————————————————————————————————————-| | contribution_percentage&lt;br /&gt;_(required)_ | &#x60;integer&#x60; | | | effective_date&lt;br /&gt;_(required)_ | &#x60;string&#x60; | The format is &#x60;YYYY-MM-DD&#x60;. | | npn&lt;br /&gt;_(required)_ | &#x60;string&#x60; | The National Producer Number | | participation_percentage&lt;br /&gt;_(required)_ | &#x60;integer&#x60; | | | product_line&lt;br /&gt;_(required)_ | &#x60;string&#x60; | The product line you wish to quote for. The options are &#x60;medical&#x60;, &#x60;dental&#x60;, or &#x60;vision&#x60;. | | rating_method&lt;br /&gt;_(required)_ | &#x60;string&#x60; | The options are &#x60;age_banded&#x60;, &#x60;4_tier_composite&#x60;, &#x60;3_tier_composite&#x60;, &#x60;2_tier_composite&#x60;, and &#x60;adult_child_tier_composite&#x60;. If we do not have a method for a plan, we will use a method we have for that plan. | | voluntary&lt;br /&gt;_(required)_ | &#x60;boolean&#x60; | | | carrier_ids&lt;br /&gt;_(optional)_ | &#x60;list&#x60; | A list of issuer_ids in string format. Only provide this key if you want to limit the carriers quoted. |

Parameters:

  • id —

    ID of the Group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(QuoteCreateResponse, Fixnum, Hash)>) —

    QuoteCreateResponse data, response status code and response headers



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
 
# 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_group_with_http_info(body, opts = {}) ⇒ Array<(GroupCreateResponse, Fixnum, Hash)>

Create a Group Use this endpoint to create a new &#x60;Group&#x60;. See the [Overview Section](#header-specifying-the-group) for more information. ### Parameters #### Group _(required)_ The &#x60;group&#x60; key is a required object that contains information related to the group that will be quoted. | Field | Type | Notes | |—————————————|———–|——————————————————————————| | chamber_association&lt;br /&gt;_(required)_ | &#x60;boolean&#x60; | | | company_name&lt;br /&gt;_(required)_ | &#x60;string&#x60; | | | contact_email&lt;br /&gt;_(optional)_ | &#x60;string&#x60; | | | contact_name&lt;br /&gt;_(optional)_ | &#x60;string&#x60; | | | contact_phone&lt;br /&gt;_(optional)_ | &#x60;string&#x60; | The format is &#x60;123-123-1234&#x60;. | | external_id&lt;br /&gt;_(required)_ | &#x60;string&#x60; | A field you can use to identify the group with. This can be an empty string. | | sic_code&lt;br /&gt;_(required)_ | &#x60;string&#x60; | | #### Locations _(required)_ The &#x60;locations&#x60; 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&lt;br /&gt;_(optional)_ | &#x60;string&#x60; | A field you can use to identify the location with. This can be an empty string. | | fips_code&lt;br /&gt;_(required)_ | &#x60;string&#x60; | | | name&lt;br /&gt;_(required)_ | &#x60;string&#x60; | | | number_of_employees&lt;br /&gt;_(required)_ | &#x60;integer&#x60; | | | primary&lt;br /&gt;_(required)_ | &#x60;boolean&#x60; | | | zip_code&lt;br /&gt;_(required)_ | &#x60;string&#x60; | |

Parameters:

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GroupCreateResponse, Fixnum, Hash)>) —

    GroupCreateResponse data, response status code and response headers



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# 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

#show_group(id, opts = {}) ⇒ GroupShowResponse

Display a Group Retrieve the details for a ‘Group`

Parameters:

  • id —

    ID of the Group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1143
1144
1145
1146
 
# 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

#show_group_rates(id, opts = {}) ⇒ RatesShowResponse

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 [email protected] for updates on its availability for `dental` and `vision` quotes.

Parameters:

  • id —

    ID of the quote

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page of paginated response

  • :per_page (Integer) —

    Responses per page

Returns:



1202
1203
1204
1205
 
# 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

#show_group_rates_with_http_info(id, opts = {}) ⇒ Array<(RatesShowResponse, Fixnum, Hash)>

Display Rates Retrieve the rates for a &#x60;Quote&#x60;. The &#x60;source&#x60; key shows the source from which we received the rates. The possible values are detailed below. | Source Value | Notes | | ———— | —————————————————————————————————- | | &#x60;carrier&#x60; | The rates were received from a carrier. | | &#x60;state&#x60; | The rates originate from state filings. | | &#x60;cms&#x60; | The rates originate from Centers for Medicare &amp; Medicaid Services (CMS) filings. | | &#x60;null&#x60; | Only &#x60;Quote&#x60;s generated before the release of this key (2019-09-10) will contain null source values. | The &#x60;premiums&#x60; 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 &#x60;total_member&#x60;, &#x60;total_dependent&#x60;, and &#x60;total&#x60;. The values are the sums. | | 4_tier_composite | The keys include &#x60;employee_only&#x60;, &#x60;employee_plus_spouse&#x60;, &#x60;employee_plus_children&#x60;, &#x60;employee_plus_family&#x60;, and &#x60;total&#x60;. The values are the per-member rate for each bucket. | | 3_tier_composite | The keys include &#x60;employee_only&#x60;, &#x60;employee_plus_one&#x60;, &#x60;employee_plus_family&#x60;, and &#x60;total&#x60;. The values are the per-member rate for each bucket. | | 2_tier_composite | The keys include &#x60;employee_only&#x60;, &#x60;employee_plus_family&#x60;, and &#x60;total&#x60;. The values are the per-member rate for each bucket. | | adult_child_tier_composite | The keys include &#x60;adult&#x60;, &#x60;child&#x60;, and &#x60;total&#x60;. The values are the per-member rate for each bucket. | Notice: Please note that the &#x60;premiums&#x60; key is currently only available for &#x60;medical&#x60; Quotes. Please reach out to [email protected] for updates on its availability for &#x60;dental&#x60; and &#x60;vision&#x60; quotes.

Parameters:

  • id —

    ID of the quote

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page of paginated response

  • :per_page (Integer) —

    Responses per page

Returns:

  • (Array<(RatesShowResponse, Fixnum, Hash)>) —

    RatesShowResponse data, response status code and response headers



1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
 
# 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

#show_group_with_http_info(id, opts = {}) ⇒ Array<(GroupShowResponse, Fixnum, Hash)>

Display a Group Retrieve the details for a &#x60;Group&#x60;

Parameters:

  • id —

    ID of the Group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GroupShowResponse, Fixnum, Hash)>) —

    GroupShowResponse data, response status code and response headers



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# 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

#show_rate_member_rates(id, opts = {}) ⇒ MemberRatesShowResponse

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.

Parameters:

  • id —

    ID of the Rate

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1263
1264
1265
1266
 
# 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

#show_rate_member_rates_with_http_info(id, opts = {}) ⇒ Array<(MemberRatesShowResponse, Fixnum, Hash)>

Display Member Rates Retrieve the member-level rates for a particular &#x60;Rate&#x60; returned for a &#x60;Quote&#x60;. The &#x60;premiums&#x60; key contains the available rating methods we have for the &#x60;Rate&#x60;, along with the member-specific rates for each method. For composite methods, the category the member falls into is shown.

Parameters:

  • id —

    ID of the Rate

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MemberRatesShowResponse, Fixnum, Hash)>) —

    MemberRatesShowResponse data, response status code and response headers



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# 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

#update_group_members(id, body, opts = {}) ⇒ MembersCreateResponse

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? |

Parameters:

  • id —

    ID of the Group

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1321
1322
1323
1324
 
# 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

#update_group_members_with_http_info(id, body, opts = {}) ⇒ Array<(MembersCreateResponse, Fixnum, Hash)>

Create or Update Members Add &#x60;Member&#x60;s and their &#x60;Dependent&#x60;s to a &#x60;Group&#x60;. 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 &#x60;members&#x60; key is a required list containing the &#x60;Member&#x60;s for the &#x60;Group&#x60; and their &#x60;Dependent&#x60;s. | Field | Type | Notes | |—————————————|———–|——————————————————————————————————| | cobra&lt;br /&gt;_(required)_ | &#x60;boolean&#x60; | | | date_of_birth&lt;br /&gt;_(required)_ | &#x60;string&#x60; | The format is &#x60;YYYY-MM-DD&#x60;. Members cannot be less than 0 years old at the time of quoting. | | dependents&lt;br /&gt;_(required)_ | &#x60;list&#x60; | If the member does not have dependents, please pass an empty list. | | external_id&lt;br /&gt;_(required)_ | &#x60;string&#x60; | A field you can use to identify the member with. This can be an empty string. | | fips_code&lt;br /&gt;_(required)_ | &#x60;string&#x60; | | | gender&lt;br /&gt;_(required)_ | &#x60;string&#x60; | The options are: &#x60;M&#x60; or &#x60;F&#x60;. | | last_used_tobacco&lt;br /&gt;_(required)_ | &#x60;string&#x60; | The format is &#x60;YYYY-MM-DD&#x60;. For those that have never smoked, please pass &#x60;null&#x60;. | | location_id&lt;br /&gt;_(required)_ | &#x60;string&#x60; | The location where the member works. The identifier comes from the response when creating a &#x60;Group&#x60;. | | retiree&lt;br /&gt;_(required)_ | &#x60;boolean&#x60; | | | zip_code&lt;br /&gt;_(required)_ | &#x60;string&#x60; | | ##### Dependents The &#x60;dependents&#x60; key is a required list containing each &#x60;Dependent&#x60; the &#x60;Member&#x60; has. If the &#x60;Member&#x60; has no dependents, an empty list should be passed. | Field | Type | Notes | |—————————————|———–|———————————————————————————————————–| | date_of_birth&lt;br /&gt;_(required)_ | &#x60;string&#x60; | The format is &#x60;YYYY-MM-DD&#x60;. Dependents cannot be less than 0 years old at the time of quoting. | | gender&lt;br /&gt;_(required)_ | &#x60;string&#x60; | The options are &#x60;M&#x60; or &#x60;F&#x60;. | | last_used_tobacco&lt;br /&gt;_(required)_ | &#x60;string&#x60; | The format is &#x60;YYYY-MM-DD&#x60;. For those that have never smoked, please pass &#x60;null&#x60;. | | relationship&lt;br /&gt;_(required)_ | &#x60;string&#x60; | Please see the [Overview Section](#header-dependent-relationships) for a list of allowed relationships. | | same_household&lt;br /&gt;_(required)_ | &#x60;boolean&#x60; | Does the dependent live in the same household as the member? |

Parameters:

  • id —

    ID of the Group

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MembersCreateResponse, Fixnum, Hash)>) —

    MembersCreateResponse data, response status code and response headers



1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# 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