class VericredClient::DentalPlansApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/vericred_client/api/dental_plans_api.rb, line 1018
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

delete_dental_plan(vericred_id, opts = {}) click to toggle source

Delete a Dental Plan. Delete a Dental Plan from the database. @param vericred_id The unique Vericred id @param [Hash] opts the optional parameters @return [nil]

# File lib/vericred_client/api/dental_plans_api.rb, line 1027
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 = {}) click to toggle source

Delete a Dental Plan. Delete a Dental Plan from the database. @param vericred_id The unique Vericred id @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vericred_client/api/dental_plans_api.rb, line 1037
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 = {}) click to toggle source

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) @param body @param [Hash] opts the optional parameters @return [DentalPlanSearchResponse]

# File lib/vericred_client/api/dental_plans_api.rb, line 1083
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 = {}) click to toggle source

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) @param body @param [Hash] opts the optional parameters @return [Array<(DentalPlanSearchResponse, Fixnum, Hash)>] DentalPlanSearchResponse data, response status code and response headers

# File lib/vericred_client/api/dental_plans_api.rb, line 1093
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 = {}) click to toggle source

Create/update a Dental Plan Add or update a Dental Plan to the database. @param vericred_id The unique Vericred id @param body Dental Plan Record @param [Hash] opts the optional parameters @return [nil]

# File lib/vericred_client/api/dental_plans_api.rb, line 1141
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 = {}) click to toggle source

Create/update a Dental Plan Add or update a Dental Plan to the database. @param vericred_id The unique Vericred id @param body Dental Plan Record @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vericred_client/api/dental_plans_api.rb, line 1152
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 = {}) click to toggle source

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. @param id ID of the Plan @param [Hash] opts the optional parameters @option opts [Integer] :year Plan year (defaults to current year) @return [DentalPlanShowResponse]

# File lib/vericred_client/api/dental_plans_api.rb, line 1201
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 = {}) click to toggle source

Show Plan Show the details of a DentalPlan. @param id ID of the Plan @param [Hash] opts the optional parameters @return [DentalPlanShowResponse]

# File lib/vericred_client/api/dental_plans_api.rb, line 1260
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 = {}) click to toggle source

Show Plan Show the details of a DentalPlan. @param id ID of the Plan @param [Hash] opts the optional parameters @return [Array<(DentalPlanShowResponse, Fixnum, Hash)>] DentalPlanShowResponse data, response status code and response headers

# File lib/vericred_client/api/dental_plans_api.rb, line 1270
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 = {}) click to toggle source

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. @param id ID of the Plan @param [Hash] opts the optional parameters @option opts [Integer] :year Plan year (defaults to current year) @return [Array<(DentalPlanShowResponse, Fixnum, Hash)>] DentalPlanShowResponse data, response status code and response headers

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