docusign_esign 3.4.0.rc1 → 3.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +1 -1
- data/Gemfile.lock +73 -0
- data/README.md +7 -5
- data/docusign_esign-2.6.0.gem +0 -0
- data/docusign_esign-2.6.0.rc1.gem +0 -0
- data/docusign_esign-2.7.0.rc1.gem +0 -0
- data/docusign_esign-3.5.0.gem +0 -0
- data/docusign_esign-3.5.0.rc1.gem +0 -0
- data/docusign_esign-3.6.0.rc1.gem +0 -0
- data/lib/docusign_esign.rb +34 -0
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/.DS_Store +0 -0
- data/lib/docusign_esign/api/accounts_api.rb +949 -35
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +126 -4
- data/lib/docusign_esign/api/envelopes_api.rb +376 -2
- data/lib/docusign_esign/client/.DS_Store +0 -0
- data/lib/docusign_esign/models/account_settings_information.rb +30 -1
- data/lib/docusign_esign/models/account_signature.rb +497 -0
- data/lib/docusign_esign/models/account_signature_definition.rb +338 -0
- data/lib/docusign_esign/models/account_signatures_information.rb +187 -0
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +287 -0
- data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +277 -0
- data/lib/docusign_esign/models/bulk_send_batch_summary.rb +255 -0
- data/lib/docusign_esign/models/bulk_send_error_status.rb +207 -0
- data/lib/docusign_esign/models/conditional_recipient_rule.rb +216 -0
- data/lib/docusign_esign/models/conditional_recipient_rule_condition.rb +207 -0
- data/lib/docusign_esign/models/conditional_recipient_rule_filter.rb +235 -0
- data/lib/docusign_esign/models/correct_view_request.rb +14 -4
- data/lib/docusign_esign/models/e_note_configuration.rb +11 -1
- data/lib/docusign_esign/models/envelope.rb +13 -4
- data/lib/docusign_esign/models/envelope_definition.rb +13 -4
- data/lib/docusign_esign/models/envelope_template.rb +13 -4
- data/lib/docusign_esign/models/in_person_signer.rb +11 -1
- data/lib/docusign_esign/models/new_user.rb +11 -1
- data/lib/docusign_esign/models/notary_certificate.rb +869 -0
- data/lib/docusign_esign/models/notary_recipient.rb +1097 -0
- data/lib/docusign_esign/models/notary_seal.rb +983 -0
- data/lib/docusign_esign/models/proof_service_resource_token.rb +14 -4
- data/lib/docusign_esign/models/recipient_additional_notification.rb +14 -4
- data/lib/docusign_esign/models/recipient_group.rb +207 -0
- data/lib/docusign_esign/models/recipient_option.rb +225 -0
- data/lib/docusign_esign/models/recipient_routing.rb +184 -0
- data/lib/docusign_esign/models/recipient_rules.rb +187 -0
- data/lib/docusign_esign/models/recipients.rb +13 -1
- data/lib/docusign_esign/models/report_in_product_csv_run_request.rb +437 -0
- data/lib/docusign_esign/models/report_in_product_field.rb +215 -0
- data/lib/docusign_esign/models/report_in_product_get.rb +466 -0
- data/lib/docusign_esign/models/report_in_product_list.rb +187 -0
- data/lib/docusign_esign/models/report_in_product_list_item.rb +315 -0
- data/lib/docusign_esign/models/report_in_product_run_request.rb +397 -0
- data/lib/docusign_esign/models/report_in_product_run_response.rb +247 -0
- data/lib/docusign_esign/models/report_in_product_run_response_row.rb +194 -0
- data/lib/docusign_esign/models/report_in_product_run_response_row_fields.rb +1395 -0
- data/lib/docusign_esign/models/report_in_product_save_response.rb +185 -0
- data/lib/docusign_esign/models/report_in_product_sent_by_details.rb +199 -0
- data/lib/docusign_esign/models/sender_email_notifications.rb +11 -1
- data/lib/docusign_esign/models/signature_group.rb +205 -0
- data/lib/docusign_esign/models/signature_group_def.rb +195 -0
- data/lib/docusign_esign/models/signature_user.rb +215 -0
- data/lib/docusign_esign/models/signature_user_def.rb +205 -0
- data/lib/docusign_esign/models/signer.rb +11 -1
- data/lib/docusign_esign/models/tab_metadata.rb +21 -1
- data/lib/docusign_esign/models/tabs.rb +25 -1
- data/lib/docusign_esign/models/template_recipients.rb +13 -1
- data/lib/docusign_esign/models/template_tabs.rb +25 -1
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +20 -1
- data/lib/docusign_esign/models/witness.rb +11 -1
- data/lib/docusign_esign/models/workflow.rb +207 -0
- data/lib/docusign_esign/models/workflow_step.rb +254 -0
- data/lib/docusign_esign/version.rb +1 -1
- data/tests/Gemfile.lock +3 -3
- metadata +48 -5
- data/docusign_esign-2.4.0.gem +0 -0
@@ -29,6 +29,24 @@ module DocuSign_eSign
|
|
29
29
|
end
|
30
30
|
end
|
31
31
|
|
32
|
+
class GetBulkSendBatchesOptions
|
33
|
+
#
|
34
|
+
attr_accessor :batch_ids
|
35
|
+
|
36
|
+
#
|
37
|
+
attr_accessor :count
|
38
|
+
|
39
|
+
#
|
40
|
+
attr_accessor :start_position
|
41
|
+
|
42
|
+
#
|
43
|
+
attr_accessor :status
|
44
|
+
|
45
|
+
def self.default
|
46
|
+
@@default ||= GetBulkSendBatchesOptions.new
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
32
50
|
class GetRecipientsOptions
|
33
51
|
#
|
34
52
|
attr_accessor :include_tabs
|
@@ -45,9 +63,6 @@ module DocuSign_eSign
|
|
45
63
|
# The number of results to return. This can be 1 to 20.
|
46
64
|
attr_accessor :count
|
47
65
|
|
48
|
-
#
|
49
|
-
attr_accessor :include
|
50
|
-
|
51
66
|
# The position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0.
|
52
67
|
attr_accessor :start_position
|
53
68
|
|
@@ -393,6 +408,114 @@ module DocuSign_eSign
|
|
393
408
|
return data, status_code, headers
|
394
409
|
end
|
395
410
|
|
411
|
+
# Gets a specific bulk send batch status
|
412
|
+
#
|
413
|
+
# @param account_id The external account number (int) or account ID Guid.
|
414
|
+
# @param bulk_send_batch_id
|
415
|
+
# @return [BulkSendBatchStatus]
|
416
|
+
def get_bulk_send_batch_status(account_id, bulk_send_batch_id)
|
417
|
+
data, _status_code, _headers = get_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id)
|
418
|
+
return data
|
419
|
+
end
|
420
|
+
|
421
|
+
# Gets a specific bulk send batch status
|
422
|
+
#
|
423
|
+
# @param account_id The external account number (int) or account ID Guid.
|
424
|
+
# @param bulk_send_batch_id
|
425
|
+
# @return [Array<(BulkSendBatchStatus, Fixnum, Hash)>] BulkSendBatchStatus data, response status code and response headers
|
426
|
+
def get_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id)
|
427
|
+
if @api_client.config.debugging
|
428
|
+
@api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_bulk_send_batch_status ..."
|
429
|
+
end
|
430
|
+
# verify the required parameter 'account_id' is set
|
431
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_bulk_send_batch_status" if account_id.nil?
|
432
|
+
# verify the required parameter 'bulk_send_batch_id' is set
|
433
|
+
fail ArgumentError, "Missing the required parameter 'bulk_send_batch_id' when calling BulkEnvelopesApi.get_bulk_send_batch_status" if bulk_send_batch_id.nil?
|
434
|
+
# resource path
|
435
|
+
local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkSendBatchId' + '}', bulk_send_batch_id.to_s)
|
436
|
+
|
437
|
+
# query parameters
|
438
|
+
query_params = {}
|
439
|
+
|
440
|
+
# header parameters
|
441
|
+
header_params = {}
|
442
|
+
# HTTP header 'Accept' (if needed)
|
443
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
444
|
+
|
445
|
+
# form parameters
|
446
|
+
form_params = {}
|
447
|
+
|
448
|
+
# http body (model)
|
449
|
+
post_body = nil
|
450
|
+
auth_names = []
|
451
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
452
|
+
:header_params => header_params,
|
453
|
+
:query_params => query_params,
|
454
|
+
:form_params => form_params,
|
455
|
+
:body => post_body,
|
456
|
+
:auth_names => auth_names,
|
457
|
+
:return_type => 'BulkSendBatchStatus')
|
458
|
+
if @api_client.config.debugging
|
459
|
+
@api_client.config.logger.debug "API called: BulkEnvelopesApi#get_bulk_send_batch_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
460
|
+
end
|
461
|
+
return data, status_code, headers
|
462
|
+
end
|
463
|
+
|
464
|
+
# Returns a list of bulk send batch satuses initiated by account.
|
465
|
+
#
|
466
|
+
# @param account_id The external account number (int) or account ID Guid.
|
467
|
+
# @param DocuSign_eSign::GetBulkSendBatchesOptions Options for modifying the behavior of the function.
|
468
|
+
# @return [BulkSendBatchSummaries]
|
469
|
+
def get_bulk_send_batches(account_id, options = DocuSign_eSign::GetBulkSendBatchesOptions.default)
|
470
|
+
data, _status_code, _headers = get_bulk_send_batches_with_http_info(account_id, options)
|
471
|
+
return data
|
472
|
+
end
|
473
|
+
|
474
|
+
# Returns a list of bulk send batch satuses initiated by account.
|
475
|
+
#
|
476
|
+
# @param account_id The external account number (int) or account ID Guid.
|
477
|
+
# @param DocuSign_eSign::GetBulkSendBatchesOptions Options for modifying the behavior of the function.
|
478
|
+
# @return [Array<(BulkSendBatchSummaries, Fixnum, Hash)>] BulkSendBatchSummaries data, response status code and response headers
|
479
|
+
def get_bulk_send_batches_with_http_info(account_id, options = DocuSign_eSign::GetBulkSendBatchesOptions.default)
|
480
|
+
if @api_client.config.debugging
|
481
|
+
@api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_bulk_send_batches ..."
|
482
|
+
end
|
483
|
+
# verify the required parameter 'account_id' is set
|
484
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_bulk_send_batches" if account_id.nil?
|
485
|
+
# resource path
|
486
|
+
local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
487
|
+
|
488
|
+
# query parameters
|
489
|
+
query_params = {}
|
490
|
+
query_params[:'batch_ids'] = options.batch_ids if !options.batch_ids.nil?
|
491
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
492
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
493
|
+
query_params[:'status'] = options.status if !options.status.nil?
|
494
|
+
|
495
|
+
# header parameters
|
496
|
+
header_params = {}
|
497
|
+
# HTTP header 'Accept' (if needed)
|
498
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
499
|
+
|
500
|
+
# form parameters
|
501
|
+
form_params = {}
|
502
|
+
|
503
|
+
# http body (model)
|
504
|
+
post_body = nil
|
505
|
+
auth_names = []
|
506
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
507
|
+
:header_params => header_params,
|
508
|
+
:query_params => query_params,
|
509
|
+
:form_params => form_params,
|
510
|
+
:body => post_body,
|
511
|
+
:auth_names => auth_names,
|
512
|
+
:return_type => 'BulkSendBatchSummaries')
|
513
|
+
if @api_client.config.debugging
|
514
|
+
@api_client.config.logger.debug "API called: BulkEnvelopesApi#get_bulk_send_batches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
515
|
+
end
|
516
|
+
return data, status_code, headers
|
517
|
+
end
|
518
|
+
|
396
519
|
# Gets a specific bulk send list
|
397
520
|
#
|
398
521
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -583,7 +706,6 @@ module DocuSign_eSign
|
|
583
706
|
# query parameters
|
584
707
|
query_params = {}
|
585
708
|
query_params[:'count'] = options.count if !options.count.nil?
|
586
|
-
query_params[:'include'] = options.include if !options.include.nil?
|
587
709
|
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
588
710
|
|
589
711
|
# header parameters
|
@@ -2278,6 +2278,60 @@ module DocuSign_eSign
|
|
2278
2278
|
return data, status_code, headers
|
2279
2279
|
end
|
2280
2280
|
|
2281
|
+
# Revokes the correction view URL to the Envelope UI
|
2282
|
+
#
|
2283
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2284
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
2285
|
+
# @param correct_view_request (optional parameter)
|
2286
|
+
# @return [nil]
|
2287
|
+
def delete_envelope_correct_view(account_id, envelope_id, correct_view_request)
|
2288
|
+
delete_envelope_correct_view_with_http_info(account_id, envelope_id, correct_view_request)
|
2289
|
+
return nil
|
2290
|
+
end
|
2291
|
+
|
2292
|
+
# Revokes the correction view URL to the Envelope UI
|
2293
|
+
#
|
2294
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2295
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
2296
|
+
# @param correct_view_request (optional parameter)
|
2297
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
2298
|
+
def delete_envelope_correct_view_with_http_info(account_id, envelope_id, correct_view_request)
|
2299
|
+
if @api_client.config.debugging
|
2300
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_correct_view ..."
|
2301
|
+
end
|
2302
|
+
# verify the required parameter 'account_id' is set
|
2303
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_correct_view" if account_id.nil?
|
2304
|
+
# verify the required parameter 'envelope_id' is set
|
2305
|
+
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_correct_view" if envelope_id.nil?
|
2306
|
+
# resource path
|
2307
|
+
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
2308
|
+
|
2309
|
+
# query parameters
|
2310
|
+
query_params = {}
|
2311
|
+
|
2312
|
+
# header parameters
|
2313
|
+
header_params = {}
|
2314
|
+
# HTTP header 'Accept' (if needed)
|
2315
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2316
|
+
|
2317
|
+
# form parameters
|
2318
|
+
form_params = {}
|
2319
|
+
|
2320
|
+
# http body (model)
|
2321
|
+
post_body = @api_client.object_to_http_body(correct_view_request)
|
2322
|
+
auth_names = []
|
2323
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
2324
|
+
:header_params => header_params,
|
2325
|
+
:query_params => query_params,
|
2326
|
+
:form_params => form_params,
|
2327
|
+
:body => post_body,
|
2328
|
+
:auth_names => auth_names)
|
2329
|
+
if @api_client.config.debugging
|
2330
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_correct_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2331
|
+
end
|
2332
|
+
return data, status_code, headers
|
2333
|
+
end
|
2334
|
+
|
2281
2335
|
# Delete envelope transfer rules for an account.
|
2282
2336
|
#
|
2283
2337
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -2330,6 +2384,58 @@ module DocuSign_eSign
|
|
2330
2384
|
return data, status_code, headers
|
2331
2385
|
end
|
2332
2386
|
|
2387
|
+
# Delete the workflow definition for an envelope.
|
2388
|
+
#
|
2389
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2390
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
2391
|
+
# @return [nil]
|
2392
|
+
def delete_envelope_workflow_definition(account_id, envelope_id)
|
2393
|
+
delete_envelope_workflow_definition_with_http_info(account_id, envelope_id)
|
2394
|
+
return nil
|
2395
|
+
end
|
2396
|
+
|
2397
|
+
# Delete the workflow definition for an envelope.
|
2398
|
+
#
|
2399
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2400
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
2401
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
2402
|
+
def delete_envelope_workflow_definition_with_http_info(account_id, envelope_id)
|
2403
|
+
if @api_client.config.debugging
|
2404
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_workflow_definition ..."
|
2405
|
+
end
|
2406
|
+
# verify the required parameter 'account_id' is set
|
2407
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_workflow_definition" if account_id.nil?
|
2408
|
+
# verify the required parameter 'envelope_id' is set
|
2409
|
+
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_workflow_definition" if envelope_id.nil?
|
2410
|
+
# resource path
|
2411
|
+
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
2412
|
+
|
2413
|
+
# query parameters
|
2414
|
+
query_params = {}
|
2415
|
+
|
2416
|
+
# header parameters
|
2417
|
+
header_params = {}
|
2418
|
+
# HTTP header 'Accept' (if needed)
|
2419
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2420
|
+
|
2421
|
+
# form parameters
|
2422
|
+
form_params = {}
|
2423
|
+
|
2424
|
+
# http body (model)
|
2425
|
+
post_body = nil
|
2426
|
+
auth_names = []
|
2427
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
2428
|
+
:header_params => header_params,
|
2429
|
+
:query_params => query_params,
|
2430
|
+
:form_params => form_params,
|
2431
|
+
:body => post_body,
|
2432
|
+
:auth_names => auth_names)
|
2433
|
+
if @api_client.config.debugging
|
2434
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2435
|
+
end
|
2436
|
+
return data, status_code, headers
|
2437
|
+
end
|
2438
|
+
|
2333
2439
|
# Deletes an envelope lock.
|
2334
2440
|
# Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
|
2335
2441
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -2554,6 +2660,58 @@ module DocuSign_eSign
|
|
2554
2660
|
return data, status_code, headers
|
2555
2661
|
end
|
2556
2662
|
|
2663
|
+
# Delete the workflow definition for a template.
|
2664
|
+
#
|
2665
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2666
|
+
# @param template_id The ID of the template being accessed.
|
2667
|
+
# @return [nil]
|
2668
|
+
def delete_template_workflow_definition(account_id, template_id)
|
2669
|
+
delete_template_workflow_definition_with_http_info(account_id, template_id)
|
2670
|
+
return nil
|
2671
|
+
end
|
2672
|
+
|
2673
|
+
# Delete the workflow definition for a template.
|
2674
|
+
#
|
2675
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2676
|
+
# @param template_id The ID of the template being accessed.
|
2677
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
2678
|
+
def delete_template_workflow_definition_with_http_info(account_id, template_id)
|
2679
|
+
if @api_client.config.debugging
|
2680
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_workflow_definition ..."
|
2681
|
+
end
|
2682
|
+
# verify the required parameter 'account_id' is set
|
2683
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_workflow_definition" if account_id.nil?
|
2684
|
+
# verify the required parameter 'template_id' is set
|
2685
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_workflow_definition" if template_id.nil?
|
2686
|
+
# resource path
|
2687
|
+
local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
2688
|
+
|
2689
|
+
# query parameters
|
2690
|
+
query_params = {}
|
2691
|
+
|
2692
|
+
# header parameters
|
2693
|
+
header_params = {}
|
2694
|
+
# HTTP header 'Accept' (if needed)
|
2695
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2696
|
+
|
2697
|
+
# form parameters
|
2698
|
+
form_params = {}
|
2699
|
+
|
2700
|
+
# http body (model)
|
2701
|
+
post_body = nil
|
2702
|
+
auth_names = []
|
2703
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
2704
|
+
:header_params => header_params,
|
2705
|
+
:query_params => query_params,
|
2706
|
+
:form_params => form_params,
|
2707
|
+
:body => post_body,
|
2708
|
+
:auth_names => auth_names)
|
2709
|
+
if @api_client.config.debugging
|
2710
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#delete_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2711
|
+
end
|
2712
|
+
return data, status_code, headers
|
2713
|
+
end
|
2714
|
+
|
2557
2715
|
# Deletes a template from a document in an existing envelope.
|
2558
2716
|
# Deletes the specified template from a document in an existing envelope.
|
2559
2717
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -2839,7 +2997,7 @@ module DocuSign_eSign
|
|
2839
2997
|
# Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
|
2840
2998
|
# @param account_id The external account number (int) or account ID Guid.
|
2841
2999
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
2842
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
3000
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
2843
3001
|
# @param recipient_id The ID of the recipient being accessed.
|
2844
3002
|
# @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
|
2845
3003
|
# @return [ConsumerDisclosure]
|
@@ -2852,7 +3010,7 @@ module DocuSign_eSign
|
|
2852
3010
|
# Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
|
2853
3011
|
# @param account_id The external account number (int) or account ID Guid.
|
2854
3012
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
2855
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
3013
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
2856
3014
|
# @param recipient_id The ID of the recipient being accessed.
|
2857
3015
|
# @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
|
2858
3016
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
@@ -3427,6 +3585,59 @@ module DocuSign_eSign
|
|
3427
3585
|
return data, status_code, headers
|
3428
3586
|
end
|
3429
3587
|
|
3588
|
+
# Returns the workflow definition for an envelope.
|
3589
|
+
#
|
3590
|
+
# @param account_id The external account number (int) or account ID Guid.
|
3591
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3592
|
+
# @return [Workflow]
|
3593
|
+
def get_envelope_workflow_definition(account_id, envelope_id)
|
3594
|
+
data, _status_code, _headers = get_envelope_workflow_definition_with_http_info(account_id, envelope_id)
|
3595
|
+
return data
|
3596
|
+
end
|
3597
|
+
|
3598
|
+
# Returns the workflow definition for an envelope.
|
3599
|
+
#
|
3600
|
+
# @param account_id The external account number (int) or account ID Guid.
|
3601
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3602
|
+
# @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
|
3603
|
+
def get_envelope_workflow_definition_with_http_info(account_id, envelope_id)
|
3604
|
+
if @api_client.config.debugging
|
3605
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_workflow_definition ..."
|
3606
|
+
end
|
3607
|
+
# verify the required parameter 'account_id' is set
|
3608
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_workflow_definition" if account_id.nil?
|
3609
|
+
# verify the required parameter 'envelope_id' is set
|
3610
|
+
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_workflow_definition" if envelope_id.nil?
|
3611
|
+
# resource path
|
3612
|
+
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
3613
|
+
|
3614
|
+
# query parameters
|
3615
|
+
query_params = {}
|
3616
|
+
|
3617
|
+
# header parameters
|
3618
|
+
header_params = {}
|
3619
|
+
# HTTP header 'Accept' (if needed)
|
3620
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3621
|
+
|
3622
|
+
# form parameters
|
3623
|
+
form_params = {}
|
3624
|
+
|
3625
|
+
# http body (model)
|
3626
|
+
post_body = nil
|
3627
|
+
auth_names = []
|
3628
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
3629
|
+
:header_params => header_params,
|
3630
|
+
:query_params => query_params,
|
3631
|
+
:form_params => form_params,
|
3632
|
+
:body => post_body,
|
3633
|
+
:auth_names => auth_names,
|
3634
|
+
:return_type => 'Workflow')
|
3635
|
+
if @api_client.config.debugging
|
3636
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3637
|
+
end
|
3638
|
+
return data, status_code, headers
|
3639
|
+
end
|
3640
|
+
|
3430
3641
|
# Returns envelope form data for an existing envelope.
|
3431
3642
|
#
|
3432
3643
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -4056,6 +4267,59 @@ module DocuSign_eSign
|
|
4056
4267
|
return data, status_code, headers
|
4057
4268
|
end
|
4058
4269
|
|
4270
|
+
# Returns the workflow definition for a template.
|
4271
|
+
#
|
4272
|
+
# @param account_id The external account number (int) or account ID Guid.
|
4273
|
+
# @param template_id The ID of the template being accessed.
|
4274
|
+
# @return [Workflow]
|
4275
|
+
def get_template_workflow_definition(account_id, template_id)
|
4276
|
+
data, _status_code, _headers = get_template_workflow_definition_with_http_info(account_id, template_id)
|
4277
|
+
return data
|
4278
|
+
end
|
4279
|
+
|
4280
|
+
# Returns the workflow definition for a template.
|
4281
|
+
#
|
4282
|
+
# @param account_id The external account number (int) or account ID Guid.
|
4283
|
+
# @param template_id The ID of the template being accessed.
|
4284
|
+
# @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
|
4285
|
+
def get_template_workflow_definition_with_http_info(account_id, template_id)
|
4286
|
+
if @api_client.config.debugging
|
4287
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_workflow_definition ..."
|
4288
|
+
end
|
4289
|
+
# verify the required parameter 'account_id' is set
|
4290
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_workflow_definition" if account_id.nil?
|
4291
|
+
# verify the required parameter 'template_id' is set
|
4292
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_workflow_definition" if template_id.nil?
|
4293
|
+
# resource path
|
4294
|
+
local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
4295
|
+
|
4296
|
+
# query parameters
|
4297
|
+
query_params = {}
|
4298
|
+
|
4299
|
+
# header parameters
|
4300
|
+
header_params = {}
|
4301
|
+
# HTTP header 'Accept' (if needed)
|
4302
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4303
|
+
|
4304
|
+
# form parameters
|
4305
|
+
form_params = {}
|
4306
|
+
|
4307
|
+
# http body (model)
|
4308
|
+
post_body = nil
|
4309
|
+
auth_names = []
|
4310
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
4311
|
+
:header_params => header_params,
|
4312
|
+
:query_params => query_params,
|
4313
|
+
:form_params => form_params,
|
4314
|
+
:body => post_body,
|
4315
|
+
:auth_names => auth_names,
|
4316
|
+
:return_type => 'Workflow')
|
4317
|
+
if @api_client.config.debugging
|
4318
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#get_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4319
|
+
end
|
4320
|
+
return data, status_code, headers
|
4321
|
+
end
|
4322
|
+
|
4059
4323
|
# Gets the envelope audit events for an envelope.
|
4060
4324
|
# Gets the envelope audit events for the specified envelope.
|
4061
4325
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -5458,6 +5722,61 @@ module DocuSign_eSign
|
|
5458
5722
|
return data, status_code, headers
|
5459
5723
|
end
|
5460
5724
|
|
5725
|
+
# Updates the envelope workflow definition for an envelope.
|
5726
|
+
#
|
5727
|
+
# @param account_id The external account number (int) or account ID Guid.
|
5728
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
5729
|
+
# @param workflow (optional parameter)
|
5730
|
+
# @return [Workflow]
|
5731
|
+
def update_envelope_workflow_definition(account_id, envelope_id, workflow)
|
5732
|
+
data, _status_code, _headers = update_envelope_workflow_definition_with_http_info(account_id, envelope_id, workflow)
|
5733
|
+
return data
|
5734
|
+
end
|
5735
|
+
|
5736
|
+
# Updates the envelope workflow definition for an envelope.
|
5737
|
+
#
|
5738
|
+
# @param account_id The external account number (int) or account ID Guid.
|
5739
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
5740
|
+
# @param workflow (optional parameter)
|
5741
|
+
# @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
|
5742
|
+
def update_envelope_workflow_definition_with_http_info(account_id, envelope_id, workflow)
|
5743
|
+
if @api_client.config.debugging
|
5744
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_workflow_definition ..."
|
5745
|
+
end
|
5746
|
+
# verify the required parameter 'account_id' is set
|
5747
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_workflow_definition" if account_id.nil?
|
5748
|
+
# verify the required parameter 'envelope_id' is set
|
5749
|
+
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_workflow_definition" if envelope_id.nil?
|
5750
|
+
# resource path
|
5751
|
+
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
5752
|
+
|
5753
|
+
# query parameters
|
5754
|
+
query_params = {}
|
5755
|
+
|
5756
|
+
# header parameters
|
5757
|
+
header_params = {}
|
5758
|
+
# HTTP header 'Accept' (if needed)
|
5759
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5760
|
+
|
5761
|
+
# form parameters
|
5762
|
+
form_params = {}
|
5763
|
+
|
5764
|
+
# http body (model)
|
5765
|
+
post_body = @api_client.object_to_http_body(workflow)
|
5766
|
+
auth_names = []
|
5767
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
5768
|
+
:header_params => header_params,
|
5769
|
+
:query_params => query_params,
|
5770
|
+
:form_params => form_params,
|
5771
|
+
:body => post_body,
|
5772
|
+
:auth_names => auth_names,
|
5773
|
+
:return_type => 'Workflow')
|
5774
|
+
if @api_client.config.debugging
|
5775
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5776
|
+
end
|
5777
|
+
return data, status_code, headers
|
5778
|
+
end
|
5779
|
+
|
5461
5780
|
# Updates an envelope lock.
|
5462
5781
|
# Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
|
5463
5782
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -6082,5 +6401,60 @@ module DocuSign_eSign
|
|
6082
6401
|
end
|
6083
6402
|
return data, status_code, headers
|
6084
6403
|
end
|
6404
|
+
|
6405
|
+
# Updates the workflow definition for a template.
|
6406
|
+
#
|
6407
|
+
# @param account_id The external account number (int) or account ID Guid.
|
6408
|
+
# @param template_id The ID of the template being accessed.
|
6409
|
+
# @param workflow (optional parameter)
|
6410
|
+
# @return [Workflow]
|
6411
|
+
def update_template_workflow_definition(account_id, template_id, workflow)
|
6412
|
+
data, _status_code, _headers = update_template_workflow_definition_with_http_info(account_id, template_id, workflow)
|
6413
|
+
return data
|
6414
|
+
end
|
6415
|
+
|
6416
|
+
# Updates the workflow definition for a template.
|
6417
|
+
#
|
6418
|
+
# @param account_id The external account number (int) or account ID Guid.
|
6419
|
+
# @param template_id The ID of the template being accessed.
|
6420
|
+
# @param workflow (optional parameter)
|
6421
|
+
# @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
|
6422
|
+
def update_template_workflow_definition_with_http_info(account_id, template_id, workflow)
|
6423
|
+
if @api_client.config.debugging
|
6424
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_workflow_definition ..."
|
6425
|
+
end
|
6426
|
+
# verify the required parameter 'account_id' is set
|
6427
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_workflow_definition" if account_id.nil?
|
6428
|
+
# verify the required parameter 'template_id' is set
|
6429
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_workflow_definition" if template_id.nil?
|
6430
|
+
# resource path
|
6431
|
+
local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
6432
|
+
|
6433
|
+
# query parameters
|
6434
|
+
query_params = {}
|
6435
|
+
|
6436
|
+
# header parameters
|
6437
|
+
header_params = {}
|
6438
|
+
# HTTP header 'Accept' (if needed)
|
6439
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6440
|
+
|
6441
|
+
# form parameters
|
6442
|
+
form_params = {}
|
6443
|
+
|
6444
|
+
# http body (model)
|
6445
|
+
post_body = @api_client.object_to_http_body(workflow)
|
6446
|
+
auth_names = []
|
6447
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
6448
|
+
:header_params => header_params,
|
6449
|
+
:query_params => query_params,
|
6450
|
+
:form_params => form_params,
|
6451
|
+
:body => post_body,
|
6452
|
+
:auth_names => auth_names,
|
6453
|
+
:return_type => 'Workflow')
|
6454
|
+
if @api_client.config.debugging
|
6455
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#update_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6456
|
+
end
|
6457
|
+
return data, status_code, headers
|
6458
|
+
end
|
6085
6459
|
end
|
6086
6460
|
end
|