Class: GroupDocsSignatureCloud::SignApi

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_signature_cloud/api/sign_api.rb

Overview

GroupDocs.Signature Cloud API

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ SignApi

Initializes new instance of SignApi

Parameters:



43
44
45
46
47
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 43

def initialize(config)
  @config = config
  @api_client = ApiClient.new(config)
  @access_token = nil
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



34
35
36
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 34

def config
  @config
end

Class Method Details

.from_config(config) ⇒ SignApi

Initializes new instance of SignApi

Parameters:

Returns:

  • (SignApi) —

    New instance of SignApi



63
64
65
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 63

def self.from_config(config)
  return new(config)
end

.from_keys(app_sid, app_key) ⇒ SignApi

Initializes new instance of SignApi

Parameters:

  • Application (app_sid) —

    identifier (App SID)

  • Application (app_key) —

    private key (App Key)

Returns:

  • (SignApi) —

    New instance of SignApi



54
55
56
57
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 54

def self.from_keys(app_sid, app_key)
  config = Configuration.new(app_sid, app_key)
  return new(config)
end

Instance Method Details

#create_signatures(request) ⇒ SignResult

Creates new signatures in the document and saves resultant document into ‘Output’ folder

Parameters:

  • request —

    create_signatures_request

Returns:



71
72
73
74
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 71

def create_signatures(request)
  data, _status_code, _headers = create_signatures_with_http_info(request)
  data
end

#create_signatures_with_http_info(request) ⇒ Array<(SignResult, Fixnum, Hash)>

Creates new signatures in the document and saves resultant document into &#39;Output&#39; folder

SignResult data, response status code and response headers

Parameters:

  • request —

    create_signatures_request

Returns:

Raises:

  • (ArgumentError) 


81
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
115
116
117
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 81

def create_signatures_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? CreateSignaturesRequest

  @api_client.config.logger.debug 'Calling API: SignApi.create_signatures ...' if @api_client.config.debugging
  # verify the required parameter 'sign_settings' is set
  raise ArgumentError, 'Missing the required parameter sign_settings when calling SignApi.create_signatures' if @api_client.config.client_side_validation && request.sign_settings.nil?
  # resource path
  local_var_path = '/signature/create'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request.sign_settings)
  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,
                                                    access_token: get_access_token,
                                                    return_type: 'SignResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    SignApi#create_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_signatures(request) ⇒ DeleteResult

Deletes signatures in the document

Parameters:

  • request —

    delete_signatures_request

Returns:



123
124
125
126
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 123

def delete_signatures(request)
  data, _status_code, _headers = delete_signatures_with_http_info(request)
  data
end

#delete_signatures_with_http_info(request) ⇒ Array<(DeleteResult, Fixnum, Hash)>

Deletes signatures in the document

DeleteResult data, response status code and response headers

Parameters:

  • request —

    delete_signatures_request

Returns:

Raises:

  • (ArgumentError) 


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
161
162
163
164
165
166
167
168
169
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 133

def delete_signatures_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? DeleteSignaturesRequest

  @api_client.config.logger.debug 'Calling API: SignApi.delete_signatures ...' if @api_client.config.debugging
  # verify the required parameter 'delete_settings' is set
  raise ArgumentError, 'Missing the required parameter delete_settings when calling SignApi.delete_signatures' if @api_client.config.client_side_validation && request.delete_settings.nil?
  # resource path
  local_var_path = '/signature/delete'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request.delete_settings)
  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,
                                                    access_token: get_access_token,
                                                    return_type: 'DeleteResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    SignApi#delete_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#search_signatures(request) ⇒ SearchResult

Searches for signatures applied to the document

Parameters:

  • request —

    search_signatures_request

Returns:



175
176
177
178
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 175

def search_signatures(request)
  data, _status_code, _headers = search_signatures_with_http_info(request)
  data
end

#search_signatures_with_http_info(request) ⇒ Array<(SearchResult, Fixnum, Hash)>

Searches for signatures applied to the document

SearchResult data, response status code and response headers

Parameters:

  • request —

    search_signatures_request

Returns:

Raises:

  • (ArgumentError) 


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 185

def search_signatures_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? SearchSignaturesRequest

  @api_client.config.logger.debug 'Calling API: SignApi.search_signatures ...' if @api_client.config.debugging
  # verify the required parameter 'search_settings' is set
  raise ArgumentError, 'Missing the required parameter search_settings when calling SignApi.search_signatures' if @api_client.config.client_side_validation && request.search_settings.nil?
  # resource path
  local_var_path = '/signature/search'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request.search_settings)
  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,
                                                    access_token: get_access_token,
                                                    return_type: 'SearchResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    SignApi#search_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#update_signatures(request) ⇒ UpdateResult

Updates signatures in the document

Parameters:

  • request —

    update_signatures_request

Returns:



227
228
229
230
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 227

def update_signatures(request)
  data, _status_code, _headers = update_signatures_with_http_info(request)
  data
end

#update_signatures_with_http_info(request) ⇒ Array<(UpdateResult, Fixnum, Hash)>

Updates signatures in the document

UpdateResult data, response status code and response headers

Parameters:

  • request —

    update_signatures_request

Returns:

Raises:

  • (ArgumentError) 


237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 237

def update_signatures_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? UpdateSignaturesRequest

  @api_client.config.logger.debug 'Calling API: SignApi.update_signatures ...' if @api_client.config.debugging
  # verify the required parameter 'update_settings' is set
  raise ArgumentError, 'Missing the required parameter update_settings when calling SignApi.update_signatures' if @api_client.config.client_side_validation && request.update_settings.nil?
  # resource path
  local_var_path = '/signature/update'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request.update_settings)
  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,
                                                    access_token: get_access_token,
                                                    return_type: 'UpdateResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    SignApi#update_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#verify_signatures(request) ⇒ VerifyResult

Verifies whether document contains signatures that meet the specified criteria

Parameters:

  • request —

    verify_signatures_request

Returns:



279
280
281
282
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 279

def verify_signatures(request)
  data, _status_code, _headers = verify_signatures_with_http_info(request)
  data
end

#verify_signatures_with_http_info(request) ⇒ Array<(VerifyResult, Fixnum, Hash)>

Verifies whether document contains signatures that meet the specified criteria

VerifyResult data, response status code and response headers

Parameters:

  • request —

    verify_signatures_request

Returns:

Raises:

  • (ArgumentError) 


289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/groupdocs_signature_cloud/api/sign_api.rb', line 289

def verify_signatures_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? VerifySignaturesRequest

  @api_client.config.logger.debug 'Calling API: SignApi.verify_signatures ...' if @api_client.config.debugging
  # verify the required parameter 'verify_settings' is set
  raise ArgumentError, 'Missing the required parameter verify_settings when calling SignApi.verify_signatures' if @api_client.config.client_side_validation && request.verify_settings.nil?
  # resource path
  local_var_path = '/signature/verify'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request.verify_settings)
  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,
                                                    access_token: get_access_token,
                                                    return_type: 'VerifyResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    SignApi#verify_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end