class DocuSign_eSign::NotaryApi

create_notary(notary) click to toggle source

Add a notary to the system Registers the current user as a notary. @param notary (optional parameter) @return [Notary]

# File lib/docusign_esign/api/notary_api.rb, line 52
def create_notary(notary)
  data, _status_code, _headers = create_notary_with_http_info( notary)
  return data
end

create_notary_jurisdictions(notary_jurisdiction) click to toggle source

Add a notary jurisdiction to the system Creates a jurisdiction object. @param notary_jurisdiction (optional parameter) @return [NotaryJurisdiction]

# File lib/docusign_esign/api/notary_api.rb, line 99
def create_notary_jurisdictions(notary_jurisdiction)
  data, _status_code, _headers = create_notary_jurisdictions_with_http_info( notary_jurisdiction)
  return data
end

create_notary_jurisdictions_with_http_info(notary_jurisdiction) click to toggle source

Add a notary jurisdiction to the system Creates a jurisdiction object. @param notary_jurisdiction (optional parameter) @return [Array<(NotaryJurisdiction, Fixnum, Hash)>] NotaryJurisdiction data, response status code and response headers

# File lib/docusign_esign/api/notary_api.rb, line 108
def create_notary_jurisdictions_with_http_info(notary_jurisdiction)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.create_notary_jurisdictions ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/notary/jurisdictions".sub('{format}','json')

  # query parameters
  query_params = {}

  # 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 = @api_client.object_to_http_body(notary_jurisdiction)
  auth_names = []
  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 => 'NotaryJurisdiction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#create_notary_jurisdictions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

create_notary_with_http_info(notary) click to toggle source

Add a notary to the system Registers the current user as a notary. @param notary (optional parameter) @return [Array<(Notary, Fixnum, Hash)>] Notary data, response status code and response headers

# File lib/docusign_esign/api/notary_api.rb, line 61
def create_notary_with_http_info(notary)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.create_notary ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/notary".sub('{format}','json')

  # query parameters
  query_params = {}

  # 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 = @api_client.object_to_http_body(notary)
  auth_names = []
  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 => 'Notary')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#create_notary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

delete_notary_jurisdiction(jurisdiction_id) click to toggle source

Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction. @param jurisdiction_id @return [nil]

# File lib/docusign_esign/api/notary_api.rb, line 146
def delete_notary_jurisdiction(jurisdiction_id)
  delete_notary_jurisdiction_with_http_info(jurisdiction_id)
  return nil
end

delete_notary_jurisdiction_with_http_info(jurisdiction_id) click to toggle source

Delete a notary jurisdiction a specified user. Deletes the specified jurisdiction. @param jurisdiction_id @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/docusign_esign/api/notary_api.rb, line 155
def delete_notary_jurisdiction_with_http_info(jurisdiction_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.delete_notary_jurisdiction ..."
  end
  # verify the required parameter 'jurisdiction_id' is set
  fail ArgumentError, "Missing the required parameter 'jurisdiction_id' when calling NotaryApi.delete_notary_jurisdiction" if jurisdiction_id.nil?
  # resource path
  local_var_path = "/v2.1/current_user/notary/jurisdictions/{jurisdictionId}".sub('{format}','json').sub('{' + 'jurisdictionId' + '}', jurisdiction_id.to_s)

  # query parameters
  query_params = {}

  # 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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#delete_notary_jurisdiction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

get_notary(options = DocuSign_eSign::GetNotaryOptions.default) click to toggle source

Get notary settings for a user Gets settings for a notary user. The current user must be a notary. @param DocuSign_eSign::GetNotaryOptions Options for modifying the behavior of the function. @return [NotaryResult]

# File lib/docusign_esign/api/notary_api.rb, line 194
def get_notary(options = DocuSign_eSign::GetNotaryOptions.default)
  data, _status_code, _headers = get_notary_with_http_info(options)
  return data
end

get_notary_jurisdiction(jurisdiction_id) click to toggle source

Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for. @param jurisdiction_id @return [NotaryJurisdiction]

# File lib/docusign_esign/api/notary_api.rb, line 242
def get_notary_jurisdiction(jurisdiction_id)
  data, _status_code, _headers = get_notary_jurisdiction_with_http_info(jurisdiction_id)
  return data
end

get_notary_jurisdiction_seal(jurisdiction_id) click to toggle source

Get notary seal for a jurisdiction

@param jurisdiction_id @return [nil]

# File lib/docusign_esign/api/notary_api.rb, line 291
def get_notary_jurisdiction_seal(jurisdiction_id)
  get_notary_jurisdiction_seal_with_http_info(jurisdiction_id)
  return nil
end

get_notary_jurisdiction_seal_with_http_info(jurisdiction_id) click to toggle source

Get notary seal for a jurisdiction

@param jurisdiction_id @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/docusign_esign/api/notary_api.rb, line 300
def get_notary_jurisdiction_seal_with_http_info(jurisdiction_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.get_notary_jurisdiction_seal ..."
  end
  # verify the required parameter 'jurisdiction_id' is set
  fail ArgumentError, "Missing the required parameter 'jurisdiction_id' when calling NotaryApi.get_notary_jurisdiction_seal" if jurisdiction_id.nil?
  # resource path
  local_var_path = "/v2.1/current_user/notary/jurisdictions/{jurisdictionId}/seal".sub('{format}','json').sub('{' + 'jurisdictionId' + '}', jurisdiction_id.to_s)

  # query parameters
  query_params = {}

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

get_notary_jurisdiction_with_http_info(jurisdiction_id) click to toggle source

Get notary a jurisdiction for a user Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for. @param jurisdiction_id @return [Array<(NotaryJurisdiction, Fixnum, Hash)>] NotaryJurisdiction data, response status code and response headers

# File lib/docusign_esign/api/notary_api.rb, line 251
def get_notary_jurisdiction_with_http_info(jurisdiction_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.get_notary_jurisdiction ..."
  end
  # verify the required parameter 'jurisdiction_id' is set
  fail ArgumentError, "Missing the required parameter 'jurisdiction_id' when calling NotaryApi.get_notary_jurisdiction" if jurisdiction_id.nil?
  # resource path
  local_var_path = "/v2.1/current_user/notary/jurisdictions/{jurisdictionId}".sub('{format}','json').sub('{' + 'jurisdictionId' + '}', jurisdiction_id.to_s)

  # query parameters
  query_params = {}

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

get_notary_jurisdictions() click to toggle source

Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary. @return [NotaryJurisdictionList]

# File lib/docusign_esign/api/notary_api.rb, line 338
def get_notary_jurisdictions()
  data, _status_code, _headers = get_notary_jurisdictions_with_http_info()
  return data
end

get_notary_jurisdictions_with_http_info() click to toggle source

Get notary jurisdictions for a user Returns a list of jurisdictions that the notary is registered in. The current user must be a notary. @return [Array<(NotaryJurisdictionList, Fixnum, Hash)>] NotaryJurisdictionList data, response status code and response headers

# File lib/docusign_esign/api/notary_api.rb, line 346
def get_notary_jurisdictions_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.get_notary_jurisdictions ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/notary/jurisdictions".sub('{format}','json')

  # query parameters
  query_params = {}

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

get_notary_with_http_info(options = DocuSign_eSign::GetNotaryOptions.default) click to toggle source

Get notary settings for a user Gets settings for a notary user. The current user must be a notary. @param DocuSign_eSign::GetNotaryOptions Options for modifying the behavior of the function. @return [Array<(NotaryResult, Fixnum, Hash)>] NotaryResult data, response status code and response headers

# File lib/docusign_esign/api/notary_api.rb, line 203
def get_notary_with_http_info(options = DocuSign_eSign::GetNotaryOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.get_notary ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/notary".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'include_jurisdictions'] = options.include_jurisdictions if !options.include_jurisdictions.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 => 'NotaryResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#get_notary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

list_notary_journals(options = DocuSign_eSign::ListNotaryJournalsOptions.default) click to toggle source

Get notary jurisdictions for a user

@param DocuSign_eSign::ListNotaryJournalsOptions Options for modifying the behavior of the function. @return [NotaryJournalList]

# File lib/docusign_esign/api/notary_api.rb, line 384
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) click to toggle source

Get notary jurisdictions for a user

@param DocuSign_eSign::ListNotaryJournalsOptions Options for modifying the behavior of the function. @return [Array<(NotaryJournalList, Fixnum, Hash)>] NotaryJournalList data, response status code and response headers

# File lib/docusign_esign/api/notary_api.rb, line 393
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

update_notary(notary) click to toggle source

Update a notary Updates notary information for the current user. @param notary (optional parameter) @return [Notary]

# File lib/docusign_esign/api/notary_api.rb, line 434
def update_notary(notary)
  data, _status_code, _headers = update_notary_with_http_info( notary)
  return data
end

update_notary_jurisdiction(jurisdiction_id, notary_jurisdiction) click to toggle source

Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: “` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } “` If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: “` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" } “` @param jurisdiction_id @param notary_jurisdiction (optional parameter) @return [NotaryJurisdiction]

# File lib/docusign_esign/api/notary_api.rb, line 482
def update_notary_jurisdiction(jurisdiction_id, notary_jurisdiction)
  data, _status_code, _headers = update_notary_jurisdiction_with_http_info(jurisdiction_id,  notary_jurisdiction)
  return data
end

update_notary_jurisdiction_with_http_info(jurisdiction_id, notary_jurisdiction) click to toggle source

Update a notary jurisdiction Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } ``` If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" } ``` @param jurisdiction_id @param notary_jurisdiction (optional parameter) @return [Array<(NotaryJurisdiction, Fixnum, Hash)>] NotaryJurisdiction data, response status code and response headers

# File lib/docusign_esign/api/notary_api.rb, line 492
def update_notary_jurisdiction_with_http_info(jurisdiction_id, notary_jurisdiction)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.update_notary_jurisdiction ..."
  end
  # verify the required parameter 'jurisdiction_id' is set
  fail ArgumentError, "Missing the required parameter 'jurisdiction_id' when calling NotaryApi.update_notary_jurisdiction" if jurisdiction_id.nil?
  # resource path
  local_var_path = "/v2.1/current_user/notary/jurisdictions/{jurisdictionId}".sub('{format}','json').sub('{' + 'jurisdictionId' + '}', jurisdiction_id.to_s)

  # query parameters
  query_params = {}

  # 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 = @api_client.object_to_http_body(notary_jurisdiction)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NotaryJurisdiction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#update_notary_jurisdiction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

update_notary_with_http_info(notary) click to toggle source

Update a notary Updates notary information for the current user. @param notary (optional parameter) @return [Array<(Notary, Fixnum, Hash)>] Notary data, response status code and response headers

# File lib/docusign_esign/api/notary_api.rb, line 443
def update_notary_with_http_info(notary)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NotaryApi.update_notary ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/notary".sub('{format}','json')

  # query parameters
  query_params = {}

  # 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 = @api_client.object_to_http_body(notary)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Notary')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotaryApi#update_notary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Attributes

Public Class Methods

Public Instance Methods