Class: VericredClient::VisionPlansApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VisionPlansApi

Returns a new instance of VisionPlansApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Delete a Vision Plan. Delete a Vision Plan from the database.

Parameters:

  • vericred_id —

    The unique Vericred id

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

    the optional parameters

Returns:

  • (nil) 


1027
1028
1029
1030
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 1027

def delete_vision_plan(vericred_id, opts = {})
  delete_vision_plan_with_http_info(vericred_id, opts)
  return nil
end

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

Delete a Vision Plan. Delete a Vision 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



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
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 1037

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

#find_vision_plans(body, opts = {}) ⇒ VisionPlanSearchResponse

Search Plans ### Searching for Vision Plans Determine the available Plans and their Premiums for a particular Family in a given Location. The overview on vision plans and plan benefits can be accessed [here](#header-vision). For details on searching for Plans and their related data, see the [Quoting Vision Plans](#header-major-medical-quotes) section.

Parameters:

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

    the optional parameters

Returns:



1083
1084
1085
1086
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 1083

def find_vision_plans(body, opts = {})
  data, _status_code, _headers = find_vision_plans_with_http_info(body, opts)
  return data
end

#find_vision_plans_with_http_info(body, opts = {}) ⇒ Array<(VisionPlanSearchResponse, Fixnum, Hash)>

Search Plans ### Searching for Vision Plans Determine the available Plans and their Premiums for a particular Family in a given Location. The overview on vision plans and plan benefits can be accessed [here](#header-vision). For details on searching for Plans and their related data, see the [Quoting Vision Plans](#header-major-medical-quotes) section.

Parameters:

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

    the optional parameters

Returns:

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

    VisionPlanSearchResponse data, response status code and response headers



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
1131
1132
1133
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 1093

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

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

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

Parameters:

  • vericred_id —

    The unique Vericred id

  • body —

    Vision Plan Record

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

    the optional parameters

Returns:

  • (nil) 


1141
1142
1143
1144
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 1141

def put_vision_plan(vericred_id, body, opts = {})
  put_vision_plan_with_http_info(vericred_id, body, opts)
  return nil
end

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

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

Parameters:

  • vericred_id —

    The unique Vericred id

  • body —

    Vision Plan Record

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
1191
1192
1193
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 1152

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

#show_medical_plan(id, opts = {}) ⇒ VisionPlanShowResponse

Show Plan ### Retrieving Benefits for a Vision Plan Show the details of an individual Plan. This includes all [benefits](#header-vision) 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:



1201
1202
1203
1204
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 1201

def show_medical_plan(id, opts = {})
  data, _status_code, _headers = show_medical_plan_with_http_info(id, opts)
  return data
end

#show_medical_plan_with_http_info(id, opts = {}) ⇒ Array<(VisionPlanShowResponse, Fixnum, Hash)>

Show Plan ### Retrieving Benefits for a Vision Plan Show the details of an individual Plan. This includes all [benefits](#header-vision) 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<(VisionPlanShowResponse, Fixnum, Hash)>) —

    VisionPlanShowResponse data, response status code and response headers



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
1251
1252
1253
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 1212

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

#show_vision_plan(id, opts = {}) ⇒ VisionPlanShowResponse

Show Plan Show the details of a VisionPlan.

Parameters:

  • id —

    ID of the Plan

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

    the optional parameters

Returns:



1260
1261
1262
1263
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 1260

def show_vision_plan(id, opts = {})
  data, _status_code, _headers = show_vision_plan_with_http_info(id, opts)
  return data
end

#show_vision_plan_with_http_info(id, opts = {}) ⇒ Array<(VisionPlanShowResponse, Fixnum, Hash)>

Show Plan Show the details of a VisionPlan.

Parameters:

  • id —

    ID of the Plan

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

    the optional parameters

Returns:

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

    VisionPlanShowResponse data, response status code and response headers



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
1308
1309
1310
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 1270

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