class ProtonApi::PortfolioConstructionApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

mvo(mvo_request, opts = {}) click to toggle source

MVO Run a mean-variance optimization for a group of potential investments @param mvo_request Request payload for MVO @param [Hash] opts the optional parameters @return [Hash<String, Object>]

# File lib/proton_api/api/portfolio_construction_api.rb, line 27
def mvo(mvo_request, opts = {})
  data, _status_code, _headers = mvo_with_http_info(mvo_request, opts)
  data
end
mvo_with_http_info(mvo_request, opts = {}) click to toggle source

MVO Run a mean-variance optimization for a group of potential investments @param mvo_request Request payload for MVO @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/portfolio_construction_api.rb, line 37
def mvo_with_http_info(mvo_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PortfolioConstructionApi.mvo ...'
  end
  # verify the required parameter 'mvo_request' is set
  if @api_client.config.client_side_validation && mvo_request.nil?
    fail ArgumentError, "Missing the required parameter 'mvo_request' when calling PortfolioConstructionApi.mvo"
  end
  # resource path
  local_var_path = '/mvo'

  # 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(mvo_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: PortfolioConstructionApi#mvo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end