Method: Propertyware::PortfoliosApi#get_portfolio_conversation_with_http_info

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

#get_portfolio_conversation_with_http_info(portfolio_id, conversation_id, opts = {}) ⇒ Array<(Conversation, Integer, Hash)>

Retrieve a portfolio conversation Retrieves a specific portfolio conversation.&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;Read&lt;/code&gt;

Parameters:

  • portfolio_id (Integer) —

    Portfolio ID

  • conversation_id (Integer) —

    Conversation ID

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/propertyware/api/portfolios_api.rb', line 310

def get_portfolio_conversation_with_http_info(portfolio_id, conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PortfoliosApi.get_portfolio_conversation ...'
  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.get_portfolio_conversation"
  end
  # verify the required parameter 'conversation_id' is set
  if @api_client.config.client_side_validation && conversation_id.nil?
    fail ArgumentError, "Missing the required parameter 'conversation_id' when calling PortfoliosApi.get_portfolio_conversation"
  end
  # resource path
  local_var_path = '/portfolios/{portfolioID}/conversations/{conversationID}'.sub('{' + 'portfolioID' + '}', CGI.escape(portfolio_id.to_s)).sub('{' + 'conversationID' + '}', CGI.escape(conversation_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'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"PortfoliosApi.get_portfolio_conversation",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortfoliosApi#get_portfolio_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end