class ProtonApi::UtilApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

decision_tree_result(decision_tree_result_request, opts = {}) click to toggle source

Decision Tree Result Traverse a decision tree and find the resulting leaf node @param decision_tree_result_request Request payload for Decision Tree Result @param [Hash] opts the optional parameters @return [Hash<String, Object>]

# File lib/proton_api/api/util_api.rb, line 27
def decision_tree_result(decision_tree_result_request, opts = {})
  data, _status_code, _headers = decision_tree_result_with_http_info(decision_tree_result_request, opts)
  data
end
decision_tree_result_with_http_info(decision_tree_result_request, opts = {}) click to toggle source

Decision Tree Result Traverse a decision tree and find the resulting leaf node @param decision_tree_result_request Request payload for Decision Tree Result @param [Hash] opts the optional parameters @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers

# File lib/proton_api/api/util_api.rb, line 37
def decision_tree_result_with_http_info(decision_tree_result_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilApi.decision_tree_result ...'
  end
  # verify the required parameter 'decision_tree_result_request' is set
  if @api_client.config.client_side_validation && decision_tree_result_request.nil?
    fail ArgumentError, "Missing the required parameter 'decision_tree_result_request' when calling UtilApi.decision_tree_result"
  end
  # resource path
  local_var_path = '/decision_tree_result'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(decision_tree_result_request)
  auth_names = ['oauth2']
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilApi#decision_tree_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
order_rebalance(order_rebalance_request, opts = {}) click to toggle source

Order Rebalance Create orders to rebalance client accounts or portfolios @param order_rebalance_request Request payload for Order Rebalance @param [Hash] opts the optional parameters @return [Hash<String, Object>]

# File lib/proton_api/api/util_api.rb, line 81
def order_rebalance(order_rebalance_request, opts = {})
  data, _status_code, _headers = order_rebalance_with_http_info(order_rebalance_request, opts)
  data
end
order_rebalance_with_http_info(order_rebalance_request, opts = {}) click to toggle source

Order Rebalance Create orders to rebalance client accounts or portfolios @param order_rebalance_request Request payload for Order Rebalance @param [Hash] opts the optional parameters @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers

# File lib/proton_api/api/util_api.rb, line 91
def order_rebalance_with_http_info(order_rebalance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilApi.order_rebalance ...'
  end
  # verify the required parameter 'order_rebalance_request' is set
  if @api_client.config.client_side_validation && order_rebalance_request.nil?
    fail ArgumentError, "Missing the required parameter 'order_rebalance_request' when calling UtilApi.order_rebalance"
  end
  # resource path
  local_var_path = '/order_rebalance'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(order_rebalance_request)
  auth_names = ['oauth2']
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilApi#order_rebalance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
performance_calculator(performance_calculator_request, opts = {}) click to toggle source

Performance Calculator Calculate performance/risk metrics for a Nucleus entity @param performance_calculator_request Request payload for Performance Calculator @param [Hash] opts the optional parameters @return [Hash<String, Object>]

# File lib/proton_api/api/util_api.rb, line 135
def performance_calculator(performance_calculator_request, opts = {})
  data, _status_code, _headers = performance_calculator_with_http_info(performance_calculator_request, opts)
  data
end
performance_calculator_with_http_info(performance_calculator_request, opts = {}) click to toggle source

Performance Calculator Calculate performance/risk metrics for a Nucleus entity @param performance_calculator_request Request payload for Performance Calculator @param [Hash] opts the optional parameters @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers

# File lib/proton_api/api/util_api.rb, line 145
def performance_calculator_with_http_info(performance_calculator_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilApi.performance_calculator ...'
  end
  # verify the required parameter 'performance_calculator_request' is set
  if @api_client.config.client_side_validation && performance_calculator_request.nil?
    fail ArgumentError, "Missing the required parameter 'performance_calculator_request' when calling UtilApi.performance_calculator"
  end
  # resource path
  local_var_path = '/performance_calculator'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(performance_calculator_request)
  auth_names = ['oauth2']
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilApi#performance_calculator\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end