docusign_esign 3.3.0.pre.rc → 3.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +5 -0
  3. data/Gemfile.lock +7 -7
  4. data/README.md +7 -5
  5. data/docusign_esign-2.6.0.rc1.gem +0 -0
  6. data/docusign_esign-3.5.0.rc1.gem +0 -0
  7. data/lib/docusign_esign.rb +25 -0
  8. data/lib/docusign_esign/.DS_Store +0 -0
  9. data/lib/docusign_esign/api/accounts_api.rb +362 -0
  10. data/lib/docusign_esign/api/bulk_envelopes_api.rb +128 -6
  11. data/lib/docusign_esign/api/envelopes_api.rb +320 -0
  12. data/lib/docusign_esign/api/trust_service_providers_api.rb +74 -0
  13. data/lib/{.DS_Store → docusign_esign/client/.DS_Store} +0 -0
  14. data/lib/docusign_esign/models/account_settings_information.rb +11 -1
  15. data/lib/docusign_esign/models/bulk_send_batch_status.rb +287 -0
  16. data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +277 -0
  17. data/lib/docusign_esign/models/bulk_send_batch_summary.rb +255 -0
  18. data/lib/docusign_esign/models/bulk_send_error_status.rb +207 -0
  19. data/lib/docusign_esign/models/bulk_send_response.rb +34 -4
  20. data/lib/docusign_esign/models/conditional_recipient_rule.rb +216 -0
  21. data/lib/docusign_esign/models/conditional_recipient_rule_condition.rb +207 -0
  22. data/lib/docusign_esign/models/conditional_recipient_rule_filter.rb +235 -0
  23. data/lib/docusign_esign/models/e_note_configuration.rb +11 -1
  24. data/lib/docusign_esign/models/envelope.rb +13 -4
  25. data/lib/docusign_esign/models/envelope_definition.rb +13 -4
  26. data/lib/docusign_esign/models/envelope_template.rb +13 -4
  27. data/lib/docusign_esign/models/new_user.rb +11 -1
  28. data/lib/docusign_esign/models/proof_service_resource_token.rb +14 -4
  29. data/lib/docusign_esign/models/recipient_additional_notification.rb +14 -4
  30. data/lib/docusign_esign/models/recipient_group.rb +207 -0
  31. data/lib/docusign_esign/models/recipient_option.rb +225 -0
  32. data/lib/docusign_esign/models/recipient_routing.rb +184 -0
  33. data/lib/docusign_esign/models/recipient_rules.rb +187 -0
  34. data/lib/docusign_esign/models/report_in_product_csv_run_request.rb +437 -0
  35. data/lib/docusign_esign/models/report_in_product_field.rb +215 -0
  36. data/lib/docusign_esign/models/report_in_product_get.rb +466 -0
  37. data/lib/docusign_esign/models/report_in_product_list.rb +187 -0
  38. data/lib/docusign_esign/models/report_in_product_list_item.rb +315 -0
  39. data/lib/docusign_esign/models/report_in_product_run_request.rb +397 -0
  40. data/lib/docusign_esign/models/report_in_product_run_response.rb +247 -0
  41. data/lib/docusign_esign/models/report_in_product_run_response_row.rb +194 -0
  42. data/lib/docusign_esign/models/report_in_product_run_response_row_fields.rb +1395 -0
  43. data/lib/docusign_esign/models/report_in_product_save_response.rb +185 -0
  44. data/lib/docusign_esign/models/report_in_product_sent_by_details.rb +199 -0
  45. data/lib/docusign_esign/models/sender_email_notifications.rb +11 -1
  46. data/lib/docusign_esign/models/tab_metadata.rb +21 -1
  47. data/lib/docusign_esign/models/workflow.rb +207 -0
  48. data/lib/docusign_esign/models/workflow_step.rb +254 -0
  49. data/lib/docusign_esign/version.rb +1 -1
  50. data/tests/Gemfile.lock +9 -9
  51. metadata +57 -31
@@ -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
@@ -668,7 +790,7 @@ module DocuSign_eSign
668
790
  # Adds or replaces envelope bulk recipients.
669
791
  # Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
670
792
  # @param account_id The external account number (int) or account ID GUID.
671
- # @param envelope_id The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
793
+ # @param envelope_id The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
672
794
  # @param recipient_id A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
673
795
  # @param bulk_recipients_request
674
796
  # @return [BulkRecipientsSummaryResponse]
@@ -680,7 +802,7 @@ module DocuSign_eSign
680
802
  # Adds or replaces envelope bulk recipients.
681
803
  # Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
682
804
  # @param account_id The external account number (int) or account ID GUID.
683
- # @param envelope_id The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
805
+ # @param envelope_id The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
684
806
  # @param recipient_id A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
685
807
  # @param bulk_recipients_request
686
808
  # @return [Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>] BulkRecipientsSummaryResponse data, response status code and response headers
@@ -2330,6 +2330,58 @@ module DocuSign_eSign
2330
2330
  return data, status_code, headers
2331
2331
  end
2332
2332
 
2333
+ # Delete the workflow definition for an envelope.
2334
+ #
2335
+ # @param account_id The external account number (int) or account ID Guid.
2336
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2337
+ # @return [nil]
2338
+ def delete_envelope_workflow_definition(account_id, envelope_id)
2339
+ delete_envelope_workflow_definition_with_http_info(account_id, envelope_id)
2340
+ return nil
2341
+ end
2342
+
2343
+ # Delete the workflow definition for an envelope.
2344
+ #
2345
+ # @param account_id The external account number (int) or account ID Guid.
2346
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
2347
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2348
+ def delete_envelope_workflow_definition_with_http_info(account_id, envelope_id)
2349
+ if @api_client.config.debugging
2350
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_workflow_definition ..."
2351
+ end
2352
+ # verify the required parameter 'account_id' is set
2353
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_workflow_definition" if account_id.nil?
2354
+ # verify the required parameter 'envelope_id' is set
2355
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_workflow_definition" if envelope_id.nil?
2356
+ # resource path
2357
+ 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)
2358
+
2359
+ # query parameters
2360
+ query_params = {}
2361
+
2362
+ # header parameters
2363
+ header_params = {}
2364
+ # HTTP header 'Accept' (if needed)
2365
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2366
+
2367
+ # form parameters
2368
+ form_params = {}
2369
+
2370
+ # http body (model)
2371
+ post_body = nil
2372
+ auth_names = []
2373
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2374
+ :header_params => header_params,
2375
+ :query_params => query_params,
2376
+ :form_params => form_params,
2377
+ :body => post_body,
2378
+ :auth_names => auth_names)
2379
+ if @api_client.config.debugging
2380
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2381
+ end
2382
+ return data, status_code, headers
2383
+ end
2384
+
2333
2385
  # Deletes an envelope lock.
2334
2386
  # Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
2335
2387
  # @param account_id The external account number (int) or account ID Guid.
@@ -2554,6 +2606,58 @@ module DocuSign_eSign
2554
2606
  return data, status_code, headers
2555
2607
  end
2556
2608
 
2609
+ # Delete the workflow definition for a template.
2610
+ #
2611
+ # @param account_id The external account number (int) or account ID Guid.
2612
+ # @param template_id The ID of the template being accessed.
2613
+ # @return [nil]
2614
+ def delete_template_workflow_definition(account_id, template_id)
2615
+ delete_template_workflow_definition_with_http_info(account_id, template_id)
2616
+ return nil
2617
+ end
2618
+
2619
+ # Delete the workflow definition for a template.
2620
+ #
2621
+ # @param account_id The external account number (int) or account ID Guid.
2622
+ # @param template_id The ID of the template being accessed.
2623
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2624
+ def delete_template_workflow_definition_with_http_info(account_id, template_id)
2625
+ if @api_client.config.debugging
2626
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_workflow_definition ..."
2627
+ end
2628
+ # verify the required parameter 'account_id' is set
2629
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_workflow_definition" if account_id.nil?
2630
+ # verify the required parameter 'template_id' is set
2631
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_workflow_definition" if template_id.nil?
2632
+ # resource path
2633
+ 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)
2634
+
2635
+ # query parameters
2636
+ query_params = {}
2637
+
2638
+ # header parameters
2639
+ header_params = {}
2640
+ # HTTP header 'Accept' (if needed)
2641
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2642
+
2643
+ # form parameters
2644
+ form_params = {}
2645
+
2646
+ # http body (model)
2647
+ post_body = nil
2648
+ auth_names = []
2649
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2650
+ :header_params => header_params,
2651
+ :query_params => query_params,
2652
+ :form_params => form_params,
2653
+ :body => post_body,
2654
+ :auth_names => auth_names)
2655
+ if @api_client.config.debugging
2656
+ @api_client.config.logger.debug "API called: EnvelopesApi#delete_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2657
+ end
2658
+ return data, status_code, headers
2659
+ end
2660
+
2557
2661
  # Deletes a template from a document in an existing envelope.
2558
2662
  # Deletes the specified template from a document in an existing envelope.
2559
2663
  # @param account_id The external account number (int) or account ID Guid.
@@ -3427,6 +3531,59 @@ module DocuSign_eSign
3427
3531
  return data, status_code, headers
3428
3532
  end
3429
3533
 
3534
+ # Returns the workflow definition for an envelope.
3535
+ #
3536
+ # @param account_id The external account number (int) or account ID Guid.
3537
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3538
+ # @return [Workflow]
3539
+ def get_envelope_workflow_definition(account_id, envelope_id)
3540
+ data, _status_code, _headers = get_envelope_workflow_definition_with_http_info(account_id, envelope_id)
3541
+ return data
3542
+ end
3543
+
3544
+ # Returns the workflow definition for an envelope.
3545
+ #
3546
+ # @param account_id The external account number (int) or account ID Guid.
3547
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
3548
+ # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
3549
+ def get_envelope_workflow_definition_with_http_info(account_id, envelope_id)
3550
+ if @api_client.config.debugging
3551
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_workflow_definition ..."
3552
+ end
3553
+ # verify the required parameter 'account_id' is set
3554
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_workflow_definition" if account_id.nil?
3555
+ # verify the required parameter 'envelope_id' is set
3556
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_workflow_definition" if envelope_id.nil?
3557
+ # resource path
3558
+ 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)
3559
+
3560
+ # query parameters
3561
+ query_params = {}
3562
+
3563
+ # header parameters
3564
+ header_params = {}
3565
+ # HTTP header 'Accept' (if needed)
3566
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3567
+
3568
+ # form parameters
3569
+ form_params = {}
3570
+
3571
+ # http body (model)
3572
+ post_body = nil
3573
+ auth_names = []
3574
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3575
+ :header_params => header_params,
3576
+ :query_params => query_params,
3577
+ :form_params => form_params,
3578
+ :body => post_body,
3579
+ :auth_names => auth_names,
3580
+ :return_type => 'Workflow')
3581
+ if @api_client.config.debugging
3582
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3583
+ end
3584
+ return data, status_code, headers
3585
+ end
3586
+
3430
3587
  # Returns envelope form data for an existing envelope.
3431
3588
  #
3432
3589
  # @param account_id The external account number (int) or account ID Guid.
@@ -4056,6 +4213,59 @@ module DocuSign_eSign
4056
4213
  return data, status_code, headers
4057
4214
  end
4058
4215
 
4216
+ # Returns the workflow definition for a template.
4217
+ #
4218
+ # @param account_id The external account number (int) or account ID Guid.
4219
+ # @param template_id The ID of the template being accessed.
4220
+ # @return [Workflow]
4221
+ def get_template_workflow_definition(account_id, template_id)
4222
+ data, _status_code, _headers = get_template_workflow_definition_with_http_info(account_id, template_id)
4223
+ return data
4224
+ end
4225
+
4226
+ # Returns the workflow definition for a template.
4227
+ #
4228
+ # @param account_id The external account number (int) or account ID Guid.
4229
+ # @param template_id The ID of the template being accessed.
4230
+ # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
4231
+ def get_template_workflow_definition_with_http_info(account_id, template_id)
4232
+ if @api_client.config.debugging
4233
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_workflow_definition ..."
4234
+ end
4235
+ # verify the required parameter 'account_id' is set
4236
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_workflow_definition" if account_id.nil?
4237
+ # verify the required parameter 'template_id' is set
4238
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_workflow_definition" if template_id.nil?
4239
+ # resource path
4240
+ 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)
4241
+
4242
+ # query parameters
4243
+ query_params = {}
4244
+
4245
+ # header parameters
4246
+ header_params = {}
4247
+ # HTTP header 'Accept' (if needed)
4248
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4249
+
4250
+ # form parameters
4251
+ form_params = {}
4252
+
4253
+ # http body (model)
4254
+ post_body = nil
4255
+ auth_names = []
4256
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4257
+ :header_params => header_params,
4258
+ :query_params => query_params,
4259
+ :form_params => form_params,
4260
+ :body => post_body,
4261
+ :auth_names => auth_names,
4262
+ :return_type => 'Workflow')
4263
+ if @api_client.config.debugging
4264
+ @api_client.config.logger.debug "API called: EnvelopesApi#get_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4265
+ end
4266
+ return data, status_code, headers
4267
+ end
4268
+
4059
4269
  # Gets the envelope audit events for an envelope.
4060
4270
  # Gets the envelope audit events for the specified envelope.
4061
4271
  # @param account_id The external account number (int) or account ID Guid.
@@ -5458,6 +5668,61 @@ module DocuSign_eSign
5458
5668
  return data, status_code, headers
5459
5669
  end
5460
5670
 
5671
+ # Updates the envelope workflow definition for an envelope.
5672
+ #
5673
+ # @param account_id The external account number (int) or account ID Guid.
5674
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5675
+ # @param workflow (optional parameter)
5676
+ # @return [Workflow]
5677
+ def update_envelope_workflow_definition(account_id, envelope_id, workflow)
5678
+ data, _status_code, _headers = update_envelope_workflow_definition_with_http_info(account_id, envelope_id, workflow)
5679
+ return data
5680
+ end
5681
+
5682
+ # Updates the envelope workflow definition for an envelope.
5683
+ #
5684
+ # @param account_id The external account number (int) or account ID Guid.
5685
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
5686
+ # @param workflow (optional parameter)
5687
+ # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
5688
+ def update_envelope_workflow_definition_with_http_info(account_id, envelope_id, workflow)
5689
+ if @api_client.config.debugging
5690
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_workflow_definition ..."
5691
+ end
5692
+ # verify the required parameter 'account_id' is set
5693
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_workflow_definition" if account_id.nil?
5694
+ # verify the required parameter 'envelope_id' is set
5695
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_workflow_definition" if envelope_id.nil?
5696
+ # resource path
5697
+ 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)
5698
+
5699
+ # query parameters
5700
+ query_params = {}
5701
+
5702
+ # header parameters
5703
+ header_params = {}
5704
+ # HTTP header 'Accept' (if needed)
5705
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5706
+
5707
+ # form parameters
5708
+ form_params = {}
5709
+
5710
+ # http body (model)
5711
+ post_body = @api_client.object_to_http_body(workflow)
5712
+ auth_names = []
5713
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
5714
+ :header_params => header_params,
5715
+ :query_params => query_params,
5716
+ :form_params => form_params,
5717
+ :body => post_body,
5718
+ :auth_names => auth_names,
5719
+ :return_type => 'Workflow')
5720
+ if @api_client.config.debugging
5721
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5722
+ end
5723
+ return data, status_code, headers
5724
+ end
5725
+
5461
5726
  # Updates an envelope lock.
5462
5727
  # 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
5728
  # @param account_id The external account number (int) or account ID Guid.
@@ -6082,5 +6347,60 @@ module DocuSign_eSign
6082
6347
  end
6083
6348
  return data, status_code, headers
6084
6349
  end
6350
+
6351
+ # Updates the workflow definition for a template.
6352
+ #
6353
+ # @param account_id The external account number (int) or account ID Guid.
6354
+ # @param template_id The ID of the template being accessed.
6355
+ # @param workflow (optional parameter)
6356
+ # @return [Workflow]
6357
+ def update_template_workflow_definition(account_id, template_id, workflow)
6358
+ data, _status_code, _headers = update_template_workflow_definition_with_http_info(account_id, template_id, workflow)
6359
+ return data
6360
+ end
6361
+
6362
+ # Updates the workflow definition for a template.
6363
+ #
6364
+ # @param account_id The external account number (int) or account ID Guid.
6365
+ # @param template_id The ID of the template being accessed.
6366
+ # @param workflow (optional parameter)
6367
+ # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
6368
+ def update_template_workflow_definition_with_http_info(account_id, template_id, workflow)
6369
+ if @api_client.config.debugging
6370
+ @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_workflow_definition ..."
6371
+ end
6372
+ # verify the required parameter 'account_id' is set
6373
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_workflow_definition" if account_id.nil?
6374
+ # verify the required parameter 'template_id' is set
6375
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_workflow_definition" if template_id.nil?
6376
+ # resource path
6377
+ 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)
6378
+
6379
+ # query parameters
6380
+ query_params = {}
6381
+
6382
+ # header parameters
6383
+ header_params = {}
6384
+ # HTTP header 'Accept' (if needed)
6385
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6386
+
6387
+ # form parameters
6388
+ form_params = {}
6389
+
6390
+ # http body (model)
6391
+ post_body = @api_client.object_to_http_body(workflow)
6392
+ auth_names = []
6393
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
6394
+ :header_params => header_params,
6395
+ :query_params => query_params,
6396
+ :form_params => form_params,
6397
+ :body => post_body,
6398
+ :auth_names => auth_names,
6399
+ :return_type => 'Workflow')
6400
+ if @api_client.config.debugging
6401
+ @api_client.config.logger.debug "API called: EnvelopesApi#update_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6402
+ end
6403
+ return data, status_code, headers
6404
+ end
6085
6405
  end
6086
6406
  end