Class: DocuSign_eSign::SignatureApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = SignatureApi.default) ⇒ SignatureApi

Returns a new instance of SignatureApi.



20
21
22
 
# File 'lib/docusign_esign/api/signature_api.rb', line 20

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



18
19
20
 
# File 'lib/docusign_esign/api/signature_api.rb', line 18

def api_client
  @api_client
end

Instance Method Details

#complete_sign_hash(complete_sign_request) ⇒ CompleteSignHashResponse

Complete Sign Hash

Parameters:

  • complete_sign_request (optional parameter)

Returns:



28
29
30
31
 
# 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) ⇒ Array<(CompleteSignHashResponse, Fixnum, Hash)>

Complete Sign Hash

Parameters:

  • complete_sign_request (optional parameter)

Returns:

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

    CompleteSignHashResponse data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# 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 ⇒ UserInfoResponse

Get User Info To Sign Document

Returns:



74
75
76
77
 
# File 'lib/docusign_esign/api/signature_api.rb', line 74

def ()
  data, _status_code, _headers = ()
  return data
end

#get_user_info_with_http_info ⇒ Array<(UserInfoResponse, Fixnum, Hash)>

Get User Info To Sign Document

Returns:

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

    UserInfoResponse data, response status code and response headers



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/docusign_esign/api/signature_api.rb', line 82

def ()
  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) ⇒ nil

Report status from the TSP to DocuSign

Parameters:

  • tsp_health_check_request (optional parameter)

Returns:

  • (nil) 


120
121
122
123
 
# 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) ⇒ Array<(nil, Fixnum, Hash)>

Report status from the TSP to DocuSign

Parameters:

  • tsp_health_check_request (optional parameter)

Returns:

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

    nil, response status code and response headers



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# 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) ⇒ SignHashSessionInfoResponse

Get Signature Session Info To Sign Document Hash

Parameters:

  • sign_session_info_request (optional parameter)

Returns:



166
167
168
169
 
# 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) ⇒ Array<(SignHashSessionInfoResponse, Fixnum, Hash)>

Get Signature Session Info To Sign Document Hash

Parameters:

  • sign_session_info_request (optional parameter)

Returns:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# 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) ⇒ UpdateTransactionResponse

Report an error from the tsp to docusign

Parameters:

  • update_transaction_request (optional parameter)

Returns:



213
214
215
216
 
# 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) ⇒ Array<(UpdateTransactionResponse, Fixnum, Hash)>

Report an error from the tsp to docusign

Parameters:

  • update_transaction_request (optional parameter)

Returns:

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

    UpdateTransactionResponse data, response status code and response headers



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# 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