Class: WhiteLabelMachineName::InstallmentPlanCalculationService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/installment_plan_calculation_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InstallmentPlanCalculationService

Returns a new instance of InstallmentPlanCalculationService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_plan_calculation_service_api.rb', line 24

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_plan_calculation_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#calculate_plans(space_id, transaction_id, opts = {}) ⇒ Array<InstallmentCalculatedPlan>

Calculate Plans This operation allows to calculate all plans for the given transaction. The transaction will not be changed in any way.

Parameters:

  • space_id
  • transaction_id —

    The transaction for which the plans should be calculated for.

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

    the optional parameters

Returns:



34
35
36
37
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_plan_calculation_service_api.rb', line 34

def calculate_plans(space_id, transaction_id, opts = {})
  data, _status_code, _headers = calculate_plans_with_http_info(space_id, transaction_id, opts)
  return data
end

#calculate_plans_with_http_info(space_id, transaction_id, opts = {}) ⇒ Array<(Array<InstallmentCalculatedPlan>, Fixnum, Hash)>

Calculate Plans This operation allows to calculate all plans for the given transaction. The transaction will not be changed in any way.

Parameters:

  • space_id
  • transaction_id —

    The transaction for which the plans should be calculated for.

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

    the optional parameters

Returns:

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

    Array<InstallmentCalculatedPlan> data, response status code and response headers



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/installment_plan_calculation_service_api.rb', line 45

def calculate_plans_with_http_info(space_id, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InstallmentPlanCalculationService.calculate_plans ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling InstallmentPlanCalculationService.calculate_plans" if space_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling InstallmentPlanCalculationService.calculate_plans" if transaction_id.nil?
  # resource path
  local_var_path = "/installment-plan-calculation/calculatePlans".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'transactionId'] = transaction_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  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 = nil
  auth_names = []
  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 => 'Array<InstallmentCalculatedPlan>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InstallmentPlanCalculationService#calculate_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end