Class: DocuSign_eSign::CommentsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/comments_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = CommentsApi.default) ⇒ CommentsApi

Returns a new instance of CommentsApi.



29
30
31
 
# File 'lib/docusign_esign/api/comments_api.rb', line 29

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



27
28
29
 
# File 'lib/docusign_esign/api/comments_api.rb', line 27

def api_client
  @api_client
end

Instance Method Details

#get_comments_transcript(account_id, envelope_id, options = DocuSign_eSign::GetCommentsTranscriptOptions.default) ⇒ File

Gets comment transcript for envelope and user

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::GetCommentsTranscriptOptions —

    Options for modifying the behavior of the function.

Returns:

  • (File) 


39
40
41
42
 
# File 'lib/docusign_esign/api/comments_api.rb', line 39

def get_comments_transcript(, envelope_id, options = DocuSign_eSign::GetCommentsTranscriptOptions.default)
  data, _status_code, _headers = get_comments_transcript_with_http_info(, envelope_id, options)
  return data
end

#get_comments_transcript_with_http_info(account_id, envelope_id, options = DocuSign_eSign::GetCommentsTranscriptOptions.default) ⇒ Array<(File, Fixnum, Hash)>

Gets comment transcript for envelope and user

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::GetCommentsTranscriptOptions —

    Options for modifying the behavior of the function.

Returns:

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

    File data, response status code and response headers



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
 
# File 'lib/docusign_esign/api/comments_api.rb', line 50

def get_comments_transcript_with_http_info(, envelope_id, options = DocuSign_eSign::GetCommentsTranscriptOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CommentsApi.get_comments_transcript ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling CommentsApi.get_comments_transcript" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling CommentsApi.get_comments_transcript" if envelope_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'encoding'] = options.encoding if !options.encoding.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommentsApi#get_comments_transcript\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end