Class: VericredClient::PlansApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PlansApi

Returns a new instance of PlansApi.



1018
1019
1020
 
# File 'lib/vericred_client/api/plans_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/plans_api.rb', line 1016

def api_client
  @api_client
end

Instance Method Details

#delete_plan(hios, year, opts = {}) ⇒ nil

Delete a plan

Parameters:

  • hios —

    HIOS ID

  • year —

    Plan year

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

    the optional parameters

Returns:

  • (nil) 


1028
1029
1030
1031
 
# File 'lib/vericred_client/api/plans_api.rb', line 1028

def delete_plan(hios, year, opts = {})
  delete_plan_with_http_info(hios, year, opts)
  return nil
end

#delete_plan_with_http_info(hios, year, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a plan

Parameters:

  • hios —

    HIOS ID

  • year —

    Plan year

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
1078
1079
1080
 
# File 'lib/vericred_client/api/plans_api.rb', line 1039

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