Class: VericredClient::DentalPlansApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DentalPlansApi

Returns a new instance of DentalPlansApi.



1015
1016
1017
 
# File 'lib/vericred_client/api/dental_plans_api.rb', line 1015

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



1013
1014
1015
 
# File 'lib/vericred_client/api/dental_plans_api.rb', line 1013

def api_client
  @api_client
end

Instance Method Details

#delete_dental_plan(vericred_id, opts = {}) ⇒ nil

Delete a Dental Plan. Delete a Dental Plan from the database.

Parameters:

  • vericred_id —

    The unique Vericred id

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

    the optional parameters

Returns:

  • (nil) 


1024
1025
1026
1027
 
# File 'lib/vericred_client/api/dental_plans_api.rb', line 1024

def delete_dental_plan(vericred_id, opts = {})
  delete_dental_plan_with_http_info(vericred_id, opts)
  return nil
end

#delete_dental_plan_with_http_info(vericred_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Dental Plan. Delete a Dental Plan from the database.

Parameters:

  • vericred_id —

    The unique Vericred id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1034
1035
1036
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
 
# File 'lib/vericred_client/api/dental_plans_api.rb', line 1034

def delete_dental_plan_with_http_info(vericred_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DentalPlansApi.delete_dental_plan ..."
  end
  # verify the required parameter 'vericred_id' is set
  fail ArgumentError, "Missing the required parameter 'vericred_id' when calling DentalPlansApi.delete_dental_plan" if vericred_id.nil?
  # resource path
  local_var_path = "/plans/dental/{vericred_id}".sub('{format}','json').sub('{' + 'vericred_id' + '}', vericred_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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DentalPlansApi#delete_dental_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#find_dental_plans(body, opts = {}) ⇒ DentalPlanSearchResponse

Search Plans ### Searching for Dental Plans Determine the available Plans and their Premiums for a particular Family in a given Location. The overview on dental plans and plan benefits can be accessed [here](#header-dental). For details on searching for Plans and their related data, see the [Quoting Dental Plans](#header-dental-quotes) section. ### Provider Data The Dental Plans are paired with [Network Provider Data](#header-network-and-provider-data)

Parameters:

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

    the optional parameters

Returns:



1080
1081
1082
1083
 
# File 'lib/vericred_client/api/dental_plans_api.rb', line 1080

def find_dental_plans(body, opts = {})
  data, _status_code, _headers = find_dental_plans_with_http_info(body, opts)
  return data
end

#find_dental_plans_with_http_info(body, opts = {}) ⇒ Array<(DentalPlanSearchResponse, Fixnum, Hash)>

Search Plans ### Searching for Dental Plans Determine the available Plans and their Premiums for a particular Family in a given Location. The overview on dental plans and plan benefits can be accessed [here](#header-dental). For details on searching for Plans and their related data, see the [Quoting Dental Plans](#header-dental-quotes) section. ### Provider Data The Dental Plans are paired with [Network Provider Data](#header-network-and-provider-data)

Parameters:

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

    the optional parameters

Returns:

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

    DentalPlanSearchResponse data, response status code and response headers



1090
1091
1092
1093
1094
1095
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
 
# File 'lib/vericred_client/api/dental_plans_api.rb', line 1090

def find_dental_plans_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DentalPlansApi.find_dental_plans ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling DentalPlansApi.find_dental_plans" if body.nil?
  # resource path
  local_var_path = "/plans/dental/search".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  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 = []
  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 => 'DentalPlanSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DentalPlansApi#find_dental_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_dental_plan(vericred_id, body, opts = {}) ⇒ nil

Create/update a Dental Plan Add or update a Dental Plan to the database.

Parameters:

  • vericred_id —

    The unique Vericred id

  • body —

    Dental Plan Record

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

    the optional parameters

Returns:

  • (nil) 


1138
1139
1140
1141
 
# File 'lib/vericred_client/api/dental_plans_api.rb', line 1138

def put_dental_plan(vericred_id, body, opts = {})
  put_dental_plan_with_http_info(vericred_id, body, opts)
  return nil
end

#put_dental_plan_with_http_info(vericred_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create/update a Dental Plan Add or update a Dental Plan to the database.

Parameters:

  • vericred_id —

    The unique Vericred id

  • body —

    Dental Plan Record

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1149
1150
1151
1152
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
 
# File 'lib/vericred_client/api/dental_plans_api.rb', line 1149

def put_dental_plan_with_http_info(vericred_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DentalPlansApi.put_dental_plan ..."
  end
  # verify the required parameter 'vericred_id' is set
  fail ArgumentError, "Missing the required parameter 'vericred_id' when calling DentalPlansApi.put_dental_plan" if vericred_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling DentalPlansApi.put_dental_plan" if body.nil?
  # resource path
  local_var_path = "/plans/dental/{vericred_id}".sub('{format}','json').sub('{' + 'vericred_id' + '}', vericred_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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DentalPlansApi#put_dental_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#show_dental_plan(id, opts = {}) ⇒ DentalPlanShowResponse

Show Plan ### Retrieving Benefits for a Dental Plan Show the details of an individual Plan. This includes all [benefits](#header-dental) for the Plan. For more details on displaying Plans and their related data, see the [Quoting](#header-individual-quotes) section.

Parameters:

  • id —

    ID of the Plan

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

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

    Plan year (defaults to current year)

Returns:



1198
1199
1200
1201
 
# File 'lib/vericred_client/api/dental_plans_api.rb', line 1198

def show_dental_plan(id, opts = {})
  data, _status_code, _headers = show_dental_plan_with_http_info(id, opts)
  return data
end

#show_dental_plan_0(id, opts = {}) ⇒ DentalPlanShowResponse

Show Plan Show the details of a DentalPlan.

Parameters:

  • id —

    ID of the Plan

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

    the optional parameters

Returns:



1257
1258
1259
1260
 
# File 'lib/vericred_client/api/dental_plans_api.rb', line 1257

def show_dental_plan_0(id, opts = {})
  data, _status_code, _headers = show_dental_plan_0_with_http_info(id, opts)
  return data
end

#show_dental_plan_0_with_http_info(id, opts = {}) ⇒ Array<(DentalPlanShowResponse, Fixnum, Hash)>

Show Plan Show the details of a DentalPlan.

Parameters:

  • id —

    ID of the Plan

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

    the optional parameters

Returns:

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

    DentalPlanShowResponse data, response status code and response headers



1267
1268
1269
1270
1271
1272
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
 
# File 'lib/vericred_client/api/dental_plans_api.rb', line 1267

def show_dental_plan_0_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DentalPlansApi.show_dental_plan_0 ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling DentalPlansApi.show_dental_plan_0" if id.nil?
  # resource path
  local_var_path = "/plans/dental/{vericred_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 => 'DentalPlanShowResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DentalPlansApi#show_dental_plan_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#show_dental_plan_with_http_info(id, opts = {}) ⇒ Array<(DentalPlanShowResponse, Fixnum, Hash)>

Show Plan ### Retrieving Benefits for a Dental Plan Show the details of an individual Plan. This includes all [benefits](#header-dental) for the Plan. For more details on displaying Plans and their related data, see the [Quoting](#header-individual-quotes) section.

Parameters:

  • id —

    ID of the Plan

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

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

    Plan year (defaults to current year)

Returns:

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

    DentalPlanShowResponse data, response status code and response headers



1209
1210
1211
1212
1213
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
 
# File 'lib/vericred_client/api/dental_plans_api.rb', line 1209

def show_dental_plan_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DentalPlansApi.show_dental_plan ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling DentalPlansApi.show_dental_plan" if id.nil?
  # resource path
  local_var_path = "/plans/dental/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'year'] = opts[:'year'] if !opts[:'year'].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 => 'DentalPlanShowResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DentalPlansApi#show_dental_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end