Method: Propertyware::PortfoliosApi#update_portfolio_with_http_info

Defined in:
lib/propertyware/api/portfolios_api.rb

#update_portfolio_with_http_info(portfolio_id, save_portfolio, opts = {}) ⇒ Array<(Portfolio, Integer, Hash)>

Update a portfolio (BETA) &lt;p class&#x3D;&quot;betaError&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Updates an existing portfolio.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;PORTFOLIOS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;

Parameters:

  • portfolio_id (Integer) —

    Portfolio ID

  • save_portfolio (SavePortfolio) —

    savePortfolio

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

    the optional parameters

Returns:

  • (Array<(Portfolio, Integer, Hash)>) —

    Portfolio data, response status code and response headers



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/propertyware/api/portfolios_api.rb', line 542

def update_portfolio_with_http_info(portfolio_id, save_portfolio, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PortfoliosApi.update_portfolio ...'
  end
  # verify the required parameter 'portfolio_id' is set
  if @api_client.config.client_side_validation && portfolio_id.nil?
    fail ArgumentError, "Missing the required parameter 'portfolio_id' when calling PortfoliosApi.update_portfolio"
  end
  # verify the required parameter 'save_portfolio' is set
  if @api_client.config.client_side_validation && save_portfolio.nil?
    fail ArgumentError, "Missing the required parameter 'save_portfolio' when calling PortfoliosApi.update_portfolio"
  end
  # resource path
  local_var_path = '/portfolios/{portfolioID}'.sub('{' + 'portfolioID' + '}', CGI.escape(portfolio_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(save_portfolio)

  # return_type
  return_type = opts[:debug_return_type] || 'Portfolio'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"PortfoliosApi.update_portfolio",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortfoliosApi#update_portfolio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end