class DocuSign_eSign::SignatureApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = SignatureApi.default) click to toggle source

# File lib/docusign_esign/api/signature_api.rb, line 20
def initialize(api_client = SignatureApi.default)
  @api_client = api_client
end

Public Instance Methods

complete_sign_hash(complete_sign_request) click to toggle source

Complete Sign Hash

@param complete_sign_request (optional parameter) @return [CompleteSignHashResponse]

# File lib/docusign_esign/api/signature_api.rb, line 28
def complete_sign_hash(complete_sign_request)
  data, _status_code, _headers = complete_sign_hash_with_http_info( complete_sign_request)
  return data
end

complete_sign_hash_with_http_info(complete_sign_request) click to toggle source

Complete Sign Hash

@param complete_sign_request (optional parameter) @return [Array<(CompleteSignHashResponse, Fixnum, Hash)>] CompleteSignHashResponse data, response status code and response headers

# File lib/docusign_esign/api/signature_api.rb, line 37
def complete_sign_hash_with_http_info(complete_sign_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SignatureApi.complete_sign_hash ..."
  end
  # resource path
  local_var_path = "/v2.1/signature/completesignhash".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(complete_sign_request)
  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 => 'CompleteSignHashResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureApi#complete_sign_hash\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

get_user_info() click to toggle source

Get User Info To Sign Document

@return [UserInfoResponse]

# File lib/docusign_esign/api/signature_api.rb, line 74
def get_user_info()
  data, _status_code, _headers = get_user_info_with_http_info()
  return data
end

get_user_info_with_http_info() click to toggle source

Get User Info To Sign Document

@return [Array<(UserInfoResponse, Fixnum, Hash)>] UserInfoResponse data, response status code and response headers

# File lib/docusign_esign/api/signature_api.rb, line 82
def get_user_info_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SignatureApi.get_user_info ..."
  end
  # resource path
  local_var_path = "/v2.1/signature/userInfo".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 => 'UserInfoResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureApi#get_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

health_check(tsp_health_check_request) click to toggle source

Report status from the TSP to DocuSign

@param tsp_health_check_request (optional parameter) @return [nil]

# File lib/docusign_esign/api/signature_api.rb, line 120
def health_check(tsp_health_check_request)
  health_check_with_http_info( tsp_health_check_request)
  return nil
end

health_check_with_http_info(tsp_health_check_request) click to toggle source

Report status from the TSP to DocuSign

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

# File lib/docusign_esign/api/signature_api.rb, line 129
def health_check_with_http_info(tsp_health_check_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SignatureApi.health_check ..."
  end
  # resource path
  local_var_path = "/v2.1/signature/healthcheck".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(tsp_health_check_request)
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureApi#health_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

sign_hash_session_info(sign_session_info_request) click to toggle source

Get Signature Session Info To Sign Document Hash

@param sign_session_info_request (optional parameter) @return [SignHashSessionInfoResponse]

# File lib/docusign_esign/api/signature_api.rb, line 166
def sign_hash_session_info(sign_session_info_request)
  data, _status_code, _headers = sign_hash_session_info_with_http_info( sign_session_info_request)
  return data
end

sign_hash_session_info_with_http_info(sign_session_info_request) click to toggle source

Get Signature Session Info To Sign Document Hash

@param sign_session_info_request (optional parameter) @return [Array<(SignHashSessionInfoResponse, Fixnum, Hash)>] SignHashSessionInfoResponse data, response status code and response headers

# File lib/docusign_esign/api/signature_api.rb, line 175
def sign_hash_session_info_with_http_info(sign_session_info_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SignatureApi.sign_hash_session_info ..."
  end
  # resource path
  local_var_path = "/v2.1/signature/signhashsessioninfo".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(sign_session_info_request)
  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 => 'SignHashSessionInfoResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureApi#sign_hash_session_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

update_transaction(update_transaction_request) click to toggle source

Report an error from the tsp to docusign

@param update_transaction_request (optional parameter) @return [UpdateTransactionResponse]

# File lib/docusign_esign/api/signature_api.rb, line 213
def update_transaction(update_transaction_request)
  data, _status_code, _headers = update_transaction_with_http_info( update_transaction_request)
  return data
end

update_transaction_with_http_info(update_transaction_request) click to toggle source

Report an error from the tsp to docusign

@param update_transaction_request (optional parameter) @return [Array<(UpdateTransactionResponse, Fixnum, Hash)>] UpdateTransactionResponse data, response status code and response headers

# File lib/docusign_esign/api/signature_api.rb, line 222
def update_transaction_with_http_info(update_transaction_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SignatureApi.update_transaction ..."
  end
  # resource path
  local_var_path = "/v2.1/signature/updatetransaction".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(update_transaction_request)
  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 => 'UpdateTransactionResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureApi#update_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end