Class: DocuSign_eSign::NotaryApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = NotaryApi.default) ⇒ NotaryApi

Returns a new instance of NotaryApi.



35
36
37
 
# File 'lib/docusign_esign/api/notary_api.rb', line 35

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



33
34
35
 
# File 'lib/docusign_esign/api/notary_api.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#list_notary_journals(options = DocuSign_eSign::ListNotaryJournalsOptions.default) ⇒ NotaryJournalList

Get notary jurisdictions for a user

Parameters:

  • DocuSign_eSign::ListNotaryJournalsOptions —

    Options for modifying the behavior of the function.

Returns:



43
44
45
46
 
# File 'lib/docusign_esign/api/notary_api.rb', line 43

def list_notary_journals(options = DocuSign_eSign::ListNotaryJournalsOptions.default)
  data, _status_code, _headers = list_notary_journals_with_http_info(options)
  return data
end

#list_notary_journals_with_http_info(options = DocuSign_eSign::ListNotaryJournalsOptions.default) ⇒ Array<(NotaryJournalList, Fixnum, Hash)>

Get notary jurisdictions for a user

Parameters:

  • DocuSign_eSign::ListNotaryJournalsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    NotaryJournalList data, response status code and response headers



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/notary_api.rb', line 52

def list_notary_journals_with_http_info(options = DocuSign_eSign::ListNotaryJournalsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.list_notary_journals ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/notary/journals".sub('{format}','json')

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

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

  # 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 => 'NotaryJournalList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#list_notary_journals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end