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.



990
991
992
 
# File 'lib/vericred_client/api/quoting_api.rb', line 990

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



988
989
990
 
# File 'lib/vericred_client/api/quoting_api.rb', line 988

def api_client
  @api_client
end

Instance Method Details

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

Create a Group Create a new [‘Group`](#header-specifying-the-group) with which you can create [`Member`s](#quoting-quoting-put) and [`Quote`s](#quoting-quoting-post-1)

Parameters:

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

    the optional parameters

Returns:



999
1000
1001
1002
 
# File 'lib/vericred_client/api/quoting_api.rb', line 999

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`

Parameters:

  • id —

    ID of the Group

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

    the optional parameters

Options Hash (opts):

Returns:



1057
1058
1059
1060
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1057

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;

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



1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1068

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 Create a new [&#x60;Group&#x60;](#header-specifying-the-group) with which you can create [&#x60;Member&#x60;s](#quoting-quoting-put) and [&#x60;Quote&#x60;s](#quoting-quoting-post-1)

Parameters:

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

    the optional parameters

Returns:

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

    GroupCreateResponse data, response status code and response headers



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1009

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:



1115
1116
1117
1118
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1115

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 null

Parameters:

  • id —

    ID of the quote

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

    the optional parameters

Returns:



1172
1173
1174
1175
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1172

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 null

Parameters:

  • id —

    ID of the quote

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

    the optional parameters

Returns:

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

    RatesShowResponse data, response status code and response headers



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1182

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 = {}

  # 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



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1125

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 null

Parameters:

  • id —

    ID of the Rate

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

    the optional parameters

Returns:



1229
1230
1231
1232
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1229

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 null

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



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1239

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 = {}) ⇒ nil

Create or Update Members Specify the ‘Member`s and `Dependent`s for the `Group`

Parameters:

  • id —

    ID of the Group

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

    the optional parameters

Returns:

  • (nil) 


1287
1288
1289
1290
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1287

def update_group_members(id, body, opts = {})
  update_group_members_with_http_info(id, body, opts)
  return nil
end

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

Create or Update Members Specify the &#x60;Member&#x60;s and &#x60;Dependent&#x60;s for the &#x60;Group&#x60;

Parameters:

  • id —

    ID of the Group

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/vericred_client/api/quoting_api.rb', line 1298

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