Class: DocuSign_eSign::EnvelopesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = EnvelopesApi.default) ⇒ EnvelopesApi

Returns a new instance of EnvelopesApi.



512
513
514
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 512

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



510
511
512
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 510

def api_client
  @api_client
end

Instance Method Details

#apply_template(account_id, envelope_id, document_template_list, options = DocuSign_eSign::ApplyTemplateOptions.default) ⇒ DocumentTemplateList

Adds templates to an envelope. Adds templates to the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_template_list (optional parameter)
  • DocuSign_eSign::ApplyTemplateOptions —

    Options for modifying the behavior of the function.

Returns:



523
524
525
526
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 523

def apply_template(, envelope_id, document_template_list, options = DocuSign_eSign::ApplyTemplateOptions.default)
  data, _status_code, _headers = apply_template_with_http_info(, envelope_id,  document_template_list, options)
  return data
end

#apply_template_to_document(account_id, document_id, envelope_id, document_template_list, options = DocuSign_eSign::ApplyTemplateToDocumentOptions.default) ⇒ DocumentTemplateList

Adds templates to a document in an envelope. Adds templates to a document in the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_template_list (optional parameter)
  • DocuSign_eSign::ApplyTemplateToDocumentOptions —

    Options for modifying the behavior of the function.

Returns:



582
583
584
585
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 582

def apply_template_to_document(, document_id, envelope_id, document_template_list, options = DocuSign_eSign::ApplyTemplateToDocumentOptions.default)
  data, _status_code, _headers = apply_template_to_document_with_http_info(, document_id, envelope_id,  document_template_list, options)
  return data
end

#apply_template_to_document_with_http_info(account_id, document_id, envelope_id, document_template_list, options = DocuSign_eSign::ApplyTemplateToDocumentOptions.default) ⇒ Array<(DocumentTemplateList, Fixnum, Hash)>

Adds templates to a document in an envelope. Adds templates to a document in the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_template_list (optional parameter)
  • DocuSign_eSign::ApplyTemplateToDocumentOptions —

    Options for modifying the behavior of the function.

Returns:

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

    DocumentTemplateList data, response status code and response headers



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 595

def apply_template_to_document_with_http_info(, document_id, envelope_id, document_template_list, options = DocuSign_eSign::ApplyTemplateToDocumentOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.apply_template_to_document ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.apply_template_to_document" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.apply_template_to_document" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.apply_template_to_document" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'preserve_template_recipient'] = options.preserve_template_recipient if !options.preserve_template_recipient.nil?

  # 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(document_template_list)
  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 => 'DocumentTemplateList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#apply_template_to_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apply_template_with_http_info(account_id, envelope_id, document_template_list, options = DocuSign_eSign::ApplyTemplateOptions.default) ⇒ Array<(DocumentTemplateList, Fixnum, Hash)>

Adds templates to an envelope. Adds templates to the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_template_list (optional parameter)
  • DocuSign_eSign::ApplyTemplateOptions —

    Options for modifying the behavior of the function.

Returns:

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

    DocumentTemplateList data, response status code and response headers



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 535

def apply_template_with_http_info(, envelope_id, document_template_list, options = DocuSign_eSign::ApplyTemplateOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.apply_template ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.apply_template" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.apply_template" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'preserve_template_recipient'] = options.preserve_template_recipient if !options.preserve_template_recipient.nil?

  # 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(document_template_list)
  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 => 'DocumentTemplateList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#apply_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_chunked_upload(account_id, chunked_upload_request) ⇒ ChunkedUploadResponse

Initiate a new ChunkedUpload. This method initiates a new chunked upload with the first part of the content.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • chunked_upload_request (optional parameter)

Returns:



641
642
643
644
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 641

def create_chunked_upload(, chunked_upload_request)
  data, _status_code, _headers = create_chunked_upload_with_http_info(,  chunked_upload_request)
  return data
end

#create_chunked_upload_with_http_info(account_id, chunked_upload_request) ⇒ Array<(ChunkedUploadResponse, Fixnum, Hash)>

Initiate a new ChunkedUpload. This method initiates a new chunked upload with the first part of the content.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • chunked_upload_request (optional parameter)

Returns:

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

    ChunkedUploadResponse data, response status code and response headers



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 651

def create_chunked_upload_with_http_info(, chunked_upload_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_chunked_upload ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_chunked_upload" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/chunked_uploads".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # 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(chunked_upload_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 => 'ChunkedUploadResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_chunked_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_console_view(account_id, console_view_request) ⇒ ViewUrl

Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • console_view_request (optional parameter)

Returns:



692
693
694
695
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 692

def create_console_view(, console_view_request)
  data, _status_code, _headers = create_console_view_with_http_info(,  console_view_request)
  return data
end

#create_console_view_with_http_info(account_id, console_view_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>

Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • console_view_request (optional parameter)

Returns:

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

    ViewUrl data, response status code and response headers



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 702

def create_console_view_with_http_info(, console_view_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_console_view ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_console_view" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/views/console".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # 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(console_view_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 => 'ViewUrl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_console_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_correct_view(account_id, envelope_id, envelope_view_request) ⇒ ViewUrl

Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_view_request (optional parameter)

Returns:



744
745
746
747
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 744

def create_correct_view(, envelope_id, envelope_view_request)
  data, _status_code, _headers = create_correct_view_with_http_info(, envelope_id,  envelope_view_request)
  return data
end

#create_correct_view_with_http_info(account_id, envelope_id, envelope_view_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>

Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_view_request (optional parameter)

Returns:

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

    ViewUrl data, response status code and response headers



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 755

def create_correct_view_with_http_info(, envelope_id, envelope_view_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_correct_view ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_correct_view" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_correct_view" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(envelope_view_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 => 'ViewUrl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_correct_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_custom_fields(account_id, envelope_id, custom_fields) ⇒ CustomFields

Updates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • custom_fields (optional parameter)

Returns:



799
800
801
802
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 799

def create_custom_fields(, envelope_id, custom_fields)
  data, _status_code, _headers = create_custom_fields_with_http_info(, envelope_id,  custom_fields)
  return data
end

#create_custom_fields_with_http_info(account_id, envelope_id, custom_fields) ⇒ Array<(CustomFields, Fixnum, Hash)>

Updates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • custom_fields (optional parameter)

Returns:

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

    CustomFields data, response status code and response headers



810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 810

def create_custom_fields_with_http_info(, envelope_id, custom_fields)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_custom_fields ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_custom_fields" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_custom_fields" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(custom_fields)
  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 => 'CustomFields')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_document_fields(account_id, document_id, envelope_id, document_fields_information) ⇒ DocumentFieldsInformation

Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_fields_information (optional parameter)

Returns:



855
856
857
858
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 855

def create_document_fields(, document_id, envelope_id, document_fields_information)
  data, _status_code, _headers = create_document_fields_with_http_info(, document_id, envelope_id,  document_fields_information)
  return data
end

#create_document_fields_with_http_info(account_id, document_id, envelope_id, document_fields_information) ⇒ Array<(DocumentFieldsInformation, Fixnum, Hash)>

Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_fields_information (optional parameter)

Returns:

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

    DocumentFieldsInformation data, response status code and response headers



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 867

def create_document_fields_with_http_info(, document_id, envelope_id, document_fields_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_document_fields ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_document_fields" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.create_document_fields" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_document_fields" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(document_fields_information)
  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 => 'DocumentFieldsInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_document_responsive_html_preview(account_id, document_id, envelope_id, document_html_definition) ⇒ DocumentHtmlDefinitions

Get Responsive HTML Preview for a document in an envelope. Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/) HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a ‘documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_html_definition (optional parameter)

Returns:



914
915
916
917
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 914

def create_document_responsive_html_preview(, document_id, envelope_id, document_html_definition)
  data, _status_code, _headers = create_document_responsive_html_preview_with_http_info(, document_id, envelope_id,  document_html_definition)
  return data
end

#create_document_responsive_html_preview_with_http_info(account_id, document_id, envelope_id, document_html_definition) ⇒ Array<(DocumentHtmlDefinitions, Fixnum, Hash)>

Get Responsive HTML Preview for a document in an envelope. Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/) HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_html_definition (optional parameter)

Returns:

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

    DocumentHtmlDefinitions data, response status code and response headers



926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 926

def create_document_responsive_html_preview_with_http_info(, document_id, envelope_id, document_html_definition)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_document_responsive_html_preview ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_document_responsive_html_preview" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.create_document_responsive_html_preview" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_document_responsive_html_preview" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(document_html_definition)
  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 => 'DocumentHtmlDefinitions')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_document_responsive_html_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_document_tabs(account_id, document_id, envelope_id, tabs) ⇒ Tabs

Adds the tabs to an envelope document Adds tabs to the document specified by ‘documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs), your request body might look like this: “` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } “`

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • tabs (optional parameter)

Returns:



973
974
975
976
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 973

def create_document_tabs(, document_id, envelope_id, tabs)
  data, _status_code, _headers = create_document_tabs_with_http_info(, document_id, envelope_id,  tabs)
  return data
end

#create_document_tabs_with_http_info(account_id, document_id, envelope_id, tabs) ⇒ Array<(Tabs, Fixnum, Hash)>

Adds the tabs to an envelope document Adds tabs to the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;. In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs), your request body might look like this: &#x60;&#x60;&#x60; { &quot;prefillTabs&quot;: { &quot;textTabs&quot;: [ { &quot;value&quot;: &quot;a prefill text tab&quot;, &quot;pageNumber&quot;: &quot;1&quot;, &quot;documentId&quot;: &quot;1&quot;, &quot;xPosition&quot;: 316, &quot;yPosition&quot;: 97 } ] } } &#x60;&#x60;&#x60;

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • tabs (optional parameter)

Returns:

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

    Tabs data, response status code and response headers



985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 985

def create_document_tabs_with_http_info(, document_id, envelope_id, tabs)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_document_tabs ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_document_tabs" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.create_document_tabs" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_document_tabs" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(tabs)
  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 => 'Tabs')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_edit_view(account_id, envelope_id, envelope_view_request) ⇒ ViewUrl

Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_view_request (optional parameter)

Returns:



1031
1032
1033
1034
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1031

def create_edit_view(, envelope_id, envelope_view_request)
  data, _status_code, _headers = create_edit_view_with_http_info(, envelope_id,  envelope_view_request)
  return data
end

#create_edit_view_with_http_info(account_id, envelope_id, envelope_view_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>

Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_view_request (optional parameter)

Returns:

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

    ViewUrl data, response status code and response headers



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1042

def create_edit_view_with_http_info(, envelope_id, envelope_view_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_edit_view ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_edit_view" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_edit_view" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(envelope_view_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 => 'ViewUrl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_edit_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_email_settings(account_id, envelope_id, email_settings) ⇒ EmailSettings

Adds email setting overrides to an envelope. Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • email_settings (optional parameter)

Returns:



1086
1087
1088
1089
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1086

def create_email_settings(, envelope_id, email_settings)
  data, _status_code, _headers = create_email_settings_with_http_info(, envelope_id,  email_settings)
  return data
end

#create_email_settings_with_http_info(account_id, envelope_id, email_settings) ⇒ Array<(EmailSettings, Fixnum, Hash)>

Adds email setting overrides to an envelope. Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • email_settings (optional parameter)

Returns:

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

    EmailSettings data, response status code and response headers



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1097

def create_email_settings_with_http_info(, envelope_id, email_settings)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_email_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_email_settings" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_email_settings" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(email_settings)
  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 => 'EmailSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_email_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_envelope(account_id, envelope_definition, options = DocuSign_eSign::CreateEnvelopeOptions.default) ⇒ EnvelopeSummary

Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request’s ‘status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the [`document` object](#/definitions/document) ### Recipient Types An [`envelopeDefinition` object](#/definitions/envelopeDefinition) is used as the method’s body. Envelope recipients can be defined in the envelope or in templates. The ‘envelopeDefinition` object’s ‘recipients` field is an [`EnvelopeRecipients` resource object](#/definitions/EnvelopeRecipients). It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition ————– | —————– agent (can add name and email information for later recipients/signers) | [`agent`](#/definitions/agent) carbon copy (receives a copy of the documents) | [`carbonCopy`](#/definitions/carbonCopy) certified delivery (receives a copy of the documents and must acknowledge receipt) | [`certifiedDelivery`](#/definitions/certifiedDelivery) editor (can change recipients and document fields for later recipients/signers) | [`editor`](#/definitions/editor) in-person signer ("hosts" someone who signs in-person) | [`inPersonSigner`](#/definitions/inPersonSigner) intermediary (can add name and email information for some later recipients/signers.) | [`intermediary`](#/definitions/intermediary) signer (signs and/or updates document fields) | [`signer`](#/definitions/signer) Additional information about the different types of recipients is available from the [`EnvelopeRecipients` resource page](../../EnvelopeRecipients) and from the [Developer Center](www.docusign.com/developer-center/explore/features/recipients) ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an [`EnvelopeTabs` resource object](#/definitions/EnvelopeTabs). It includes arrays of the 24 different tab types available. See the [`EnvelopeTabs` resource](../../EnvelopeTabs) for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the [`EnvelopeRecipients` object](#/definitions/EnvelopeRecipients) are used to assign recipients to the template’s roles via the ‘roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` true, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope’s status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the [Webhook recipe](www.docusign.com/developer-center/recipes/webhook-status) for examples and live demos of using webhooks. ## Webhook Options The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional [eventNotification object](#definition-eventNotification) that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the [ConnectConfigurations resource](../../Connect/ConnectConfigurations). Configurations can also be created and managed from the Administration tool accessed by selecting "Go to Admin" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like [compositing in film production](en.wikipedia.org/wiki/Compositing), enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the ‘compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to "true" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat’s XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template’s ‘document` field, the first template’s document (based on the template’s Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "*" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the ‘documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: “` –5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1" Content-Transfer-Encoding: base64 “` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a *PDF Form Digital Signature Field,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be ——- | ——– DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming *PDF Form Text Fields,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be ——- | ——– DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include "DocuSignIgnoreTransform" or "eSignIgnoreTransform" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient’s ‘roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient’s name in the subject line add the following text in the ‘emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` * To add a recipient’s email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: ‘"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient’s ‘roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account’s default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account’s default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don’t use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter ‘merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_definition (optional parameter)
  • DocuSign_eSign::CreateEnvelopeOptions —

    Options for modifying the behavior of the function.

Returns:



1141
1142
1143
1144
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1141

def create_envelope(, envelope_definition, options = DocuSign_eSign::CreateEnvelopeOptions.default)
  data, _status_code, _headers = create_envelope_with_http_info(,  envelope_definition, options)
  return data
end

#create_envelope_comments(account_id, envelope_id, comments_publish) ⇒ CommentHistoryResult

Posts a list of comments for authorized user

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • comments_publish (optional parameter)

Returns:



1199
1200
1201
1202
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1199

def create_envelope_comments(, envelope_id, comments_publish)
  data, _status_code, _headers = create_envelope_comments_with_http_info(, envelope_id,  comments_publish)
  return data
end

#create_envelope_comments_with_http_info(account_id, envelope_id, comments_publish) ⇒ Array<(CommentHistoryResult, Fixnum, Hash)>

Posts a list of comments for authorized user

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • comments_publish (optional parameter)

Returns:

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

    CommentHistoryResult data, response status code and response headers



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1210

def create_envelope_comments_with_http_info(, envelope_id, comments_publish)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope_comments ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope_comments" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_envelope_comments" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(comments_publish)
  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 => 'CommentHistoryResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope_comments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_envelope_recipient_preview(account_id, envelope_id, recipient_preview_request) ⇒ ViewUrl

Provides a URL to start a recipient view of the Envelope UI This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients’ experience. For more information, see [Preview and Send](support.docusign.com/en/guides/ndse-user-guide-send-your-documents).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_preview_request (optional parameter)

Returns:



1254
1255
1256
1257
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1254

def create_envelope_recipient_preview(, envelope_id, recipient_preview_request)
  data, _status_code, _headers = create_envelope_recipient_preview_with_http_info(, envelope_id,  recipient_preview_request)
  return data
end

#create_envelope_recipient_preview_with_http_info(account_id, envelope_id, recipient_preview_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>

Provides a URL to start a recipient view of the Envelope UI This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients&#39; experience. For more information, see [Preview and Send](support.docusign.com/en/guides/ndse-user-guide-send-your-documents).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_preview_request (optional parameter)

Returns:

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

    ViewUrl data, response status code and response headers



1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1265

def create_envelope_recipient_preview_with_http_info(, envelope_id, recipient_preview_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope_recipient_preview ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope_recipient_preview" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_envelope_recipient_preview" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(recipient_preview_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 => 'ViewUrl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope_recipient_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_envelope_recipient_shared_view(account_id, envelope_id, recipient_view_request) ⇒ ViewUrl

Provides a URL to start a shared recipient view of the Envelope UI Returns a URL that enables you to embed the DocuSign UI recipient view of a [shared envelope](support.docusign.com/en/guides/ndse-admin-guide-share-envelopes) in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an ‘<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/) - [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/) - [How to embed the DocuSign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_view_request (optional parameter)

Returns:



1309
1310
1311
1312
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1309

def create_envelope_recipient_shared_view(, envelope_id, recipient_view_request)
  data, _status_code, _headers = create_envelope_recipient_shared_view_with_http_info(, envelope_id,  recipient_view_request)
  return data
end

#create_envelope_recipient_shared_view_with_http_info(account_id, envelope_id, recipient_view_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>

Provides a URL to start a shared recipient view of the Envelope UI Returns a URL that enables you to embed the DocuSign UI recipient view of a [shared envelope](support.docusign.com/en/guides/ndse-admin-guide-share-envelopes) in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an &#x60;&lt;iframe&gt;&#x60; for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/) - [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/) - [How to embed the DocuSign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_view_request (optional parameter)

Returns:

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

    ViewUrl data, response status code and response headers



1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1320

def create_envelope_recipient_shared_view_with_http_info(, envelope_id, recipient_view_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope_recipient_shared_view ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope_recipient_shared_view" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_envelope_recipient_shared_view" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(recipient_view_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 => 'ViewUrl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope_recipient_shared_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_envelope_transfer_rules(account_id, envelope_transfer_rule_request) ⇒ EnvelopeTransferRuleInformation

Add envelope transfer rules to an account. This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - ‘eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_transfer_rule_request (optional parameter)

Returns:



1363
1364
1365
1366
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1363

def create_envelope_transfer_rules(, envelope_transfer_rule_request)
  data, _status_code, _headers = create_envelope_transfer_rules_with_http_info(,  envelope_transfer_rule_request)
  return data
end

#create_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_request) ⇒ Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>

Add envelope transfer rules to an account. This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - &#x60;eventType&#x60; - &#x60;fromGroups&#x60; - &#x60;toUser&#x60; - &#x60;toFolder&#x60; - &#x60;carbonCopyOriginalOwner&#x60; - &#x60;enabled&#x60; Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_transfer_rule_request (optional parameter)

Returns:



1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1373

def create_envelope_transfer_rules_with_http_info(, envelope_transfer_rule_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope_transfer_rules ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope_transfer_rules" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # 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(envelope_transfer_rule_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 => 'EnvelopeTransferRuleInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope_transfer_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_envelope_with_http_info(account_id, envelope_definition, options = DocuSign_eSign::CreateEnvelopeOptions.default) ⇒ Array<(EnvelopeSummary, Fixnum, Hash)>

Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request&#39;s &#x60;status&#x60; property to &#x60;created&#x60; instead of &#x60;sent&#x60;. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the &#x60;documentBase64&#x60; field of the [&#x60;document&#x60; object](#/definitions/document) ### Recipient Types An [&#x60;envelopeDefinition&#x60; object](#/definitions/envelopeDefinition) is used as the method&#39;s body. Envelope recipients can be defined in the envelope or in templates. The &#x60;envelopeDefinition&#x60; object&#39;s &#x60;recipients&#x60; field is an [&#x60;EnvelopeRecipients&#x60; resource object](#/definitions/EnvelopeRecipients). It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition ————– | —————– agent (can add name and email information for later recipients/signers) | [&#x60;agent&#x60;](#/definitions/agent) carbon copy (receives a copy of the documents) | [&#x60;carbonCopy&#x60;](#/definitions/carbonCopy) certified delivery (receives a copy of the documents and must acknowledge receipt) | [&#x60;certifiedDelivery&#x60;](#/definitions/certifiedDelivery) editor (can change recipients and document fields for later recipients/signers) | [&#x60;editor&#x60;](#/definitions/editor) in-person signer (&quot;hosts&quot; someone who signs in-person) | [&#x60;inPersonSigner&#x60;](#/definitions/inPersonSigner) intermediary (can add name and email information for some later recipients/signers.) | [&#x60;intermediary&#x60;](#/definitions/intermediary) signer (signs and/or updates document fields) | [&#x60;signer&#x60;](#/definitions/signer) Additional information about the different types of recipients is available from the [&#x60;EnvelopeRecipients&#x60; resource page](../../EnvelopeRecipients) and from the [Developer Center](www.docusign.com/developer-center/explore/features/recipients) ### Tabs Tabs (also referred to as &#x60;tags&#x60; and as &#x60;fields&#x60; in the web sending user interface), can be defined in the &#x60;envelopeDefinition&#x60;, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the &#x60;inPersonSigner&#x60;, and &#x60;signer&#x60; recipient objects include a &#x60;tabs&#x60; field. It is an [&#x60;EnvelopeTabs&#x60; resource object](#/definitions/EnvelopeTabs). It includes arrays of the 24 different tab types available. See the [&#x60;EnvelopeTabs&#x60; resource](../../EnvelopeTabs) for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg &#x60;account_manager.&#x60; When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a &#x60;templateId&#x60;, the different recipient type objects within the [&#x60;EnvelopeRecipients&#x60; object](#/definitions/EnvelopeRecipients) are used to assign recipients to the template&#39;s roles via the &#x60;roleName&#x60; property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field &#x60;messageLock&#x60; is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with &#x60;messageLock&#x60; true, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope&#39;s status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the [Webhook recipe](www.docusign.com/developer-center/recipes/webhook-status) for examples and live demos of using webhooks. ## Webhook Options The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional [eventNotification object](#definition-eventNotification) that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the [ConnectConfigurations resource](../../Connect/ConnectConfigurations). Configurations can also be created and managed from the Administration tool accessed by selecting &quot;Go to Admin&quot; from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like [compositing in film production](en.wikipedia.org/wiki/Compositing), enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the &#x60;compositeTemplateId&#x60; to which the document should be added. If &#x60;compositeTemplateId&#x60; is not specified in the content-disposition, the document is applied based on the &#x60;documentId&#x60; only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set &#x60;transformPdfFields&#x60; to &quot;true&quot; for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat&#39;s XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template&#39;s &#x60;document&#x60; field, the first template&#39;s document (based on the template&#39;s Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with &quot;*&quot; and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the &#x60;documentBase64&#x60; or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the &#x60;compositeTemplateId&#x60; to which the document should be added. Using the &#x60;compositeTemplateId&#x60; sets which documents are associated with particular composite templates. An example of this usage is: &#x60;&#x60;&#x60; –5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename&#x3D;&quot;eula.pdf&quot;; documentId&#x3D;1; compositeTemplateId&#x3D;&quot;1&quot; Content-Transfer-Encoding: base64 &#x60;&#x60;&#x60; ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a *PDF Form Digital Signature Field,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be ——- | ——– DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming *PDF Form Text Fields,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be ——- | ——– DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include &quot;DocuSignIgnoreTransform&quot; or &quot;eSignIgnoreTransform&quot; will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient&#39;s &#x60;roleName&#x60;, are added to the &#x60;emailSubject&#x60; when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient&#39;s name in the subject line add the following text in the &#x60;emailSubject&#x60; when creating the template or when sending an envelope from a template: [[&lt;roleName&gt;_UserName]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_UserName]], Please sign this NDA&quot;,&#x60; * To add a recipient&#39;s email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[&lt;roleName&gt;_Email]] Example: &#x60;&quot;emailSubject&quot;:&quot;[[Signer 1_Email]], Please sign this NDA&quot;,&#x60; In both cases the &lt;roleName&gt; is the recipient&#39;s &#x60;roleName&#x60; in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[&lt;roleName&gt;_UserName]] or [[&lt;roleName&gt;_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the &#x60;brandId&#x60; used in an envelope: * If a &#x60;brandId&#x60; is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one &#x60;brandId&#x60; is specified, the first &#x60;brandId&#x60; specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account&#39;s default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account&#39;s default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don&#39;t use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter &#x60;merge_roles_on_draft&#x60; should be added when posting a draft envelope (status&#x3D;created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the &#x60;merge_roles_on_draft&#x60; query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_definition (optional parameter)
  • DocuSign_eSign::CreateEnvelopeOptions —

    Options for modifying the behavior of the function.

Returns:

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

    EnvelopeSummary data, response status code and response headers



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1152

def create_envelope_with_http_info(, envelope_definition, options = DocuSign_eSign::CreateEnvelopeOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'cdse_mode'] = options.cdse_mode if !options.cdse_mode.nil?
  query_params[:'change_routing_order'] = options.change_routing_order if !options.change_routing_order.nil?
  query_params[:'completed_documents_only'] = options.completed_documents_only if !options.completed_documents_only.nil?
  query_params[:'merge_roles_on_draft'] = options.merge_roles_on_draft if !options.merge_roles_on_draft.nil?
  query_params[:'tab_label_exact_matches'] = options.tab_label_exact_matches if !options.tab_label_exact_matches.nil?

  # 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(envelope_definition)
  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 => 'EnvelopeSummary')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_envelope_workflow_step_definition(account_id, envelope_id, workflow_step) ⇒ WorkflowStep

Creates and adds a new workflow step definition for an envelope’s workflow

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step (optional parameter)

Returns:



1415
1416
1417
1418
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1415

def create_envelope_workflow_step_definition(, envelope_id, workflow_step)
  data, _status_code, _headers = create_envelope_workflow_step_definition_with_http_info(, envelope_id,  workflow_step)
  return data
end

#create_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step) ⇒ Array<(WorkflowStep, Fixnum, Hash)>

Creates and adds a new workflow step definition for an envelope&#39;s workflow

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step (optional parameter)

Returns:

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

    WorkflowStep data, response status code and response headers



1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1426

def create_envelope_workflow_step_definition_with_http_info(, envelope_id, workflow_step)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_envelope_workflow_step_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_envelope_workflow_step_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_envelope_workflow_step_definition" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(workflow_step)
  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 => 'WorkflowStep')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_historical_envelope_publish_transaction(account_id, connect_historical_envelope_republish) ⇒ EnvelopePublishTransaction

Submits a batch of historical envelopes for republish to an adhoc config.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_historical_envelope_republish (optional parameter)

Returns:



1469
1470
1471
1472
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1469

def create_historical_envelope_publish_transaction(, connect_historical_envelope_republish)
  data, _status_code, _headers = create_historical_envelope_publish_transaction_with_http_info(,  connect_historical_envelope_republish)
  return data
end

#create_historical_envelope_publish_transaction_with_http_info(account_id, connect_historical_envelope_republish) ⇒ Array<(EnvelopePublishTransaction, Fixnum, Hash)>

Submits a batch of historical envelopes for republish to an adhoc config.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_historical_envelope_republish (optional parameter)

Returns:

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

    EnvelopePublishTransaction data, response status code and response headers



1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1479

def create_historical_envelope_publish_transaction_with_http_info(, connect_historical_envelope_republish)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_historical_envelope_publish_transaction ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_historical_envelope_publish_transaction" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/envelopes/publish/historical".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # 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(connect_historical_envelope_republish)
  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 => 'EnvelopePublishTransaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_historical_envelope_publish_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_lock(account_id, envelope_id, lock_request) ⇒ LockInformation

Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting ‘canLockEnvelopes` must be set to true for the user).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • lock_request (optional parameter)

Returns:



1521
1522
1523
1524
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1521

def create_lock(, envelope_id, lock_request)
  data, _status_code, _headers = create_lock_with_http_info(, envelope_id,  lock_request)
  return data
end

#create_lock_with_http_info(account_id, envelope_id, lock_request) ⇒ Array<(LockInformation, Fixnum, Hash)>

Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting &#x60;canLockEnvelopes&#x60; must be set to true for the user).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • lock_request (optional parameter)

Returns:

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

    LockInformation data, response status code and response headers



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1532

def create_lock_with_http_info(, envelope_id, lock_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_lock ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_lock" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_lock" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(lock_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 => 'LockInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_recipient(account_id, envelope_id, recipients, options = DocuSign_eSign::CreateRecipientOptions.default) ⇒ Recipients

Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient’s routing order is before or the same as the envelope’s next recipient, an email is only sent if the optional ‘resend_envelope` query string is set to true.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipients (optional parameter)
  • DocuSign_eSign::CreateRecipientOptions —

    Options for modifying the behavior of the function.

Returns:



1577
1578
1579
1580
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1577

def create_recipient(, envelope_id, recipients, options = DocuSign_eSign::CreateRecipientOptions.default)
  data, _status_code, _headers = create_recipient_with_http_info(, envelope_id,  recipients, options)
  return data
end

#create_recipient_manual_review_view(account_id, envelope_id, recipient_id) ⇒ ViewUrl

Provides a link to access the Identity manual review related to a recipient. This method returns the URL of the page that allows a sender to [manually review](support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:



1634
1635
1636
1637
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1634

def create_recipient_manual_review_view(, envelope_id, recipient_id)
  data, _status_code, _headers = create_recipient_manual_review_view_with_http_info(, envelope_id, recipient_id)
  return data
end

#create_recipient_manual_review_view_with_http_info(account_id, envelope_id, recipient_id) ⇒ Array<(ViewUrl, Fixnum, Hash)>

Provides a link to access the Identity manual review related to a recipient. This method returns the URL of the page that allows a sender to [manually review](support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:

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

    ViewUrl data, response status code and response headers



1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1645

def create_recipient_manual_review_view_with_http_info(, envelope_id, recipient_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient_manual_review_view ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_recipient_manual_review_view" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_recipient_manual_review_view" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.create_recipient_manual_review_view" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # 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(: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 => 'ViewUrl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_recipient_manual_review_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_recipient_proof_file_link(account_id, envelope_id, recipient_id) ⇒ IdEvidenceViewLink

Returns a link to access to the identity events stored in the proof service related to this recipient.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:



1691
1692
1693
1694
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1691

def create_recipient_proof_file_link(, envelope_id, recipient_id)
  data, _status_code, _headers = create_recipient_proof_file_link_with_http_info(, envelope_id, recipient_id)
  return data
end

#create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id) ⇒ Array<(IdEvidenceViewLink, Fixnum, Hash)>

Returns a link to access to the identity events stored in the proof service related to this recipient.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:

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

    IdEvidenceViewLink data, response status code and response headers



1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1702

def create_recipient_proof_file_link_with_http_info(, envelope_id, recipient_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient_proof_file_link ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_recipient_proof_file_link" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_recipient_proof_file_link" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.create_recipient_proof_file_link" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # 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(: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 => 'IdEvidenceViewLink')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_recipient_proof_file_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_recipient_proof_file_resource_token(account_id, envelope_id, recipient_id, options = DocuSign_eSign::CreateRecipientProofFileResourceTokenOptions.default) ⇒ IdEvidenceResourceToken

Returns a resource token to get access to the identity events stored in the proof service related to this recipient. Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • DocuSign_eSign::CreateRecipientProofFileResourceTokenOptions —

    Options for modifying the behavior of the function.

Returns:



1749
1750
1751
1752
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1749

def create_recipient_proof_file_resource_token(, envelope_id, recipient_id, options = DocuSign_eSign::CreateRecipientProofFileResourceTokenOptions.default)
  data, _status_code, _headers = create_recipient_proof_file_resource_token_with_http_info(, envelope_id, recipient_id, options)
  return data
end

#create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::CreateRecipientProofFileResourceTokenOptions.default) ⇒ Array<(IdEvidenceResourceToken, Fixnum, Hash)>

Returns a resource token to get access to the identity events stored in the proof service related to this recipient. Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • DocuSign_eSign::CreateRecipientProofFileResourceTokenOptions —

    Options for modifying the behavior of the function.

Returns:

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

    IdEvidenceResourceToken data, response status code and response headers



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1761

def create_recipient_proof_file_resource_token_with_http_info(, envelope_id, recipient_id, options = DocuSign_eSign::CreateRecipientProofFileResourceTokenOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient_proof_file_resource_token ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_recipient_proof_file_resource_token" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_recipient_proof_file_resource_token" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.create_recipient_proof_file_resource_token" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'token_scopes'] = options.token_scopes if !options.token_scopes.nil?

  # 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(: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 => 'IdEvidenceResourceToken')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_recipient_proof_file_resource_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_recipient_view(account_id, envelope_id, recipient_view_request) ⇒ ViewUrl

Returns a URL to the recipient view UI. Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the ‘securityDomain` and `authenticationMethod` properties used to verify the user identity.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_view_request (optional parameter)

Returns:



1808
1809
1810
1811
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1808

def create_recipient_view(, envelope_id, recipient_view_request)
  data, _status_code, _headers = create_recipient_view_with_http_info(, envelope_id,  recipient_view_request)
  return data
end

#create_recipient_view_with_http_info(account_id, envelope_id, recipient_view_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>

Returns a URL to the recipient view UI. Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the &#x60;securityDomain&#x60; and &#x60;authenticationMethod&#x60; properties used to verify the user identity.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_view_request (optional parameter)

Returns:

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

    ViewUrl data, response status code and response headers



1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1819

def create_recipient_view_with_http_info(, envelope_id, recipient_view_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient_view ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_recipient_view" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_recipient_view" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(recipient_view_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 => 'ViewUrl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_recipient_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_recipient_with_http_info(account_id, envelope_id, recipients, options = DocuSign_eSign::CreateRecipientOptions.default) ⇒ Array<(Recipients, Fixnum, Hash)>

Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient&#39;s routing order is before or the same as the envelope&#39;s next recipient, an email is only sent if the optional &#x60;resend_envelope&#x60; query string is set to true.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipients (optional parameter)
  • DocuSign_eSign::CreateRecipientOptions —

    Options for modifying the behavior of the function.

Returns:

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

    Recipients data, response status code and response headers



1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1589

def create_recipient_with_http_info(, envelope_id, recipients, options = DocuSign_eSign::CreateRecipientOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_recipient" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_recipient" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'resend_envelope'] = options.resend_envelope if !options.resend_envelope.nil?

  # 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(recipients)
  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 => 'Recipients')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_responsive_html_preview(account_id, envelope_id, document_html_definition) ⇒ DocumentHtmlDefinitions

Get Responsive HTML Preview for all documents in an envelope. Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a ‘documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_html_definition (optional parameter)

Returns:



1863
1864
1865
1866
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1863

def create_responsive_html_preview(, envelope_id, document_html_definition)
  data, _status_code, _headers = create_responsive_html_preview_with_http_info(, envelope_id,  document_html_definition)
  return data
end

#create_responsive_html_preview_with_http_info(account_id, envelope_id, document_html_definition) ⇒ Array<(DocumentHtmlDefinitions, Fixnum, Hash)>

Get Responsive HTML Preview for all documents in an envelope. Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a &#x60;documentHtmlDefinition&#x60; object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_html_definition (optional parameter)

Returns:

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

    DocumentHtmlDefinitions data, response status code and response headers



1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1874

def create_responsive_html_preview_with_http_info(, envelope_id, document_html_definition)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_responsive_html_preview ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_responsive_html_preview" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_responsive_html_preview" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(document_html_definition)
  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 => 'DocumentHtmlDefinitions')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_responsive_html_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_sender_view(account_id, envelope_id, envelope_view_request) ⇒ ViewUrl

Returns a URL to the sender view UI. Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_view_request (optional parameter)

Returns:



1918
1919
1920
1921
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1918

def create_sender_view(, envelope_id, envelope_view_request)
  data, _status_code, _headers = create_sender_view_with_http_info(, envelope_id,  envelope_view_request)
  return data
end

#create_sender_view_with_http_info(account_id, envelope_id, envelope_view_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>

Returns a URL to the sender view UI. Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_view_request (optional parameter)

Returns:

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

    ViewUrl data, response status code and response headers



1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1929

def create_sender_view_with_http_info(, envelope_id, envelope_view_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_sender_view ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_sender_view" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_sender_view" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(envelope_view_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 => 'ViewUrl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_sender_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_tabs(account_id, envelope_id, recipient_id, tabs) ⇒ Tabs

Adds tabs for a recipient. Adds one or more tabs for a recipient.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • tabs (optional parameter)

Returns:



1974
1975
1976
1977
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1974

def create_tabs(, envelope_id, recipient_id, tabs)
  data, _status_code, _headers = create_tabs_with_http_info(, envelope_id, recipient_id,  tabs)
  return data
end

#create_tabs_with_http_info(account_id, envelope_id, recipient_id, tabs) ⇒ Array<(Tabs, Fixnum, Hash)>

Adds tabs for a recipient. Adds one or more tabs for a recipient.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • tabs (optional parameter)

Returns:

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

    Tabs data, response status code and response headers



1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1986

def create_tabs_with_http_info(, envelope_id, recipient_id, tabs)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_tabs ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_tabs" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_tabs" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.create_tabs" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # 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(tabs)
  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 => 'Tabs')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_template_workflow_step_definition(account_id, template_id, workflow_step) ⇒ WorkflowStep

Creates and adds a new workflow step definition for a template’s workflow

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step (optional parameter)

Returns:



2032
2033
2034
2035
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2032

def create_template_workflow_step_definition(, template_id, workflow_step)
  data, _status_code, _headers = create_template_workflow_step_definition_with_http_info(, template_id,  workflow_step)
  return data
end

#create_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step) ⇒ Array<(WorkflowStep, Fixnum, Hash)>

Creates and adds a new workflow step definition for a template&#39;s workflow

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step (optional parameter)

Returns:

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

    WorkflowStep data, response status code and response headers



2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2043

def create_template_workflow_step_definition_with_http_info(, template_id, workflow_step)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.create_template_workflow_step_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.create_template_workflow_step_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.create_template_workflow_step_definition" if template_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s)

  # 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(workflow_step)
  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 => 'WorkflowStep')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#create_template_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_attachments(account_id, envelope_id, envelope_attachments_request) ⇒ EnvelopeAttachmentsResult

Delete one or more attachments from a DRAFT envelope. Deletes one or more attachments from a draft envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_attachments_request (optional parameter)

Returns:



2087
2088
2089
2090
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2087

def delete_attachments(, envelope_id, envelope_attachments_request)
  data, _status_code, _headers = delete_attachments_with_http_info(, envelope_id,  envelope_attachments_request)
  return data
end

#delete_attachments_with_http_info(account_id, envelope_id, envelope_attachments_request) ⇒ Array<(EnvelopeAttachmentsResult, Fixnum, Hash)>

Delete one or more attachments from a DRAFT envelope. Deletes one or more attachments from a draft envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_attachments_request (optional parameter)

Returns:

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

    EnvelopeAttachmentsResult data, response status code and response headers



2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2098

def delete_attachments_with_http_info(, envelope_id, envelope_attachments_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_attachments ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_attachments" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_attachments" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(envelope_attachments_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EnvelopeAttachmentsResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#delete_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_chunked_upload(account_id, chunked_upload_id) ⇒ ChunkedUploadResponse

Delete an existing ChunkedUpload. Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • chunked_upload_id

Returns:



2141
2142
2143
2144
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2141

def delete_chunked_upload(, chunked_upload_id)
  data, _status_code, _headers = delete_chunked_upload_with_http_info(, chunked_upload_id)
  return data
end

#delete_chunked_upload_with_http_info(account_id, chunked_upload_id) ⇒ Array<(ChunkedUploadResponse, Fixnum, Hash)>

Delete an existing ChunkedUpload. Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • chunked_upload_id

Returns:

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

    ChunkedUploadResponse data, response status code and response headers



2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2151

def delete_chunked_upload_with_http_info(, chunked_upload_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_chunked_upload ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_chunked_upload" if .nil?
  # verify the required parameter 'chunked_upload_id' is set
  fail ArgumentError, "Missing the required parameter 'chunked_upload_id' when calling EnvelopesApi.delete_chunked_upload" if chunked_upload_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s)

  # 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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ChunkedUploadResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#delete_chunked_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_custom_fields(account_id, envelope_id, custom_fields) ⇒ CustomFields

Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • custom_fields (optional parameter)

Returns:



2195
2196
2197
2198
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2195

def delete_custom_fields(, envelope_id, custom_fields)
  data, _status_code, _headers = delete_custom_fields_with_http_info(, envelope_id,  custom_fields)
  return data
end

#delete_custom_fields_with_http_info(account_id, envelope_id, custom_fields) ⇒ Array<(CustomFields, Fixnum, Hash)>

Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • custom_fields (optional parameter)

Returns:

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

    CustomFields data, response status code and response headers



2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2206

def delete_custom_fields_with_http_info(, envelope_id, custom_fields)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_custom_fields ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_custom_fields" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_custom_fields" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(custom_fields)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CustomFields')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#delete_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_document_fields(account_id, document_id, envelope_id, document_fields_information) ⇒ DocumentFieldsInformation

Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_fields_information (optional parameter)

Returns:



2251
2252
2253
2254
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2251

def delete_document_fields(, document_id, envelope_id, document_fields_information)
  data, _status_code, _headers = delete_document_fields_with_http_info(, document_id, envelope_id,  document_fields_information)
  return data
end

#delete_document_fields_with_http_info(account_id, document_id, envelope_id, document_fields_information) ⇒ Array<(DocumentFieldsInformation, Fixnum, Hash)>

Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_fields_information (optional parameter)

Returns:

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

    DocumentFieldsInformation data, response status code and response headers



2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2263

def delete_document_fields_with_http_info(, document_id, envelope_id, document_fields_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_document_fields ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_document_fields" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.delete_document_fields" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_document_fields" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(document_fields_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentFieldsInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#delete_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_document_page(account_id, document_id, envelope_id, page_number) ⇒ nil

Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • page_number —

    The page number being accessed.

Returns:

  • (nil) 


2310
2311
2312
2313
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2310

def delete_document_page(, document_id, envelope_id, page_number)
  delete_document_page_with_http_info(, document_id, envelope_id, page_number)
  return nil
end

#delete_document_page_with_http_info(account_id, document_id, envelope_id, page_number) ⇒ Array<(nil, Fixnum, Hash)>

Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • page_number —

    The page number being accessed.

Returns:

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

    nil, response status code and response headers



2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2322

def delete_document_page_with_http_info(, document_id, envelope_id, page_number)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_document_page ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_document_page" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.delete_document_page" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_document_page" if envelope_id.nil?
  # verify the required parameter 'page_number' is set
  fail ArgumentError, "Missing the required parameter 'page_number' when calling EnvelopesApi.delete_document_page" if page_number.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # 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(:DELETE, 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: EnvelopesApi#delete_document_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_document_tabs(account_id, document_id, envelope_id, tabs) ⇒ Tabs

Deletes tabs from an envelope document Deletes tabs from the document specified by ‘documentId` in the envelope specified by `envelopeId`.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • tabs (optional parameter)

Returns:



2370
2371
2372
2373
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2370

def delete_document_tabs(, document_id, envelope_id, tabs)
  data, _status_code, _headers = delete_document_tabs_with_http_info(, document_id, envelope_id,  tabs)
  return data
end

#delete_document_tabs_with_http_info(account_id, document_id, envelope_id, tabs) ⇒ Array<(Tabs, Fixnum, Hash)>

Deletes tabs from an envelope document Deletes tabs from the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • tabs (optional parameter)

Returns:

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

    Tabs data, response status code and response headers



2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2382

def delete_document_tabs_with_http_info(, document_id, envelope_id, tabs)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_document_tabs ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_document_tabs" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.delete_document_tabs" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_document_tabs" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(tabs)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Tabs')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#delete_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_documents(account_id, envelope_id, envelope_definition) ⇒ EnvelopeDocumentsResult

Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_definition (optional parameter)

Returns:



2428
2429
2430
2431
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2428

def delete_documents(, envelope_id, envelope_definition)
  data, _status_code, _headers = delete_documents_with_http_info(, envelope_id,  envelope_definition)
  return data
end

#delete_documents_with_http_info(account_id, envelope_id, envelope_definition) ⇒ Array<(EnvelopeDocumentsResult, Fixnum, Hash)>

Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_definition (optional parameter)

Returns:

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

    EnvelopeDocumentsResult data, response status code and response headers



2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2439

def delete_documents_with_http_info(, envelope_id, envelope_definition)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_documents ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_documents" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_documents" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(envelope_definition)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EnvelopeDocumentsResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#delete_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_email_settings(account_id, envelope_id) ⇒ EmailSettings

Deletes the email setting overrides for an envelope. Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



2482
2483
2484
2485
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2482

def delete_email_settings(, envelope_id)
  data, _status_code, _headers = delete_email_settings_with_http_info(, envelope_id)
  return data
end

#delete_email_settings_with_http_info(account_id, envelope_id) ⇒ Array<(EmailSettings, Fixnum, Hash)>

Deletes the email setting overrides for an envelope. Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    EmailSettings data, response status code and response headers



2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2492

def delete_email_settings_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_email_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_email_settings" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_email_settings" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#delete_email_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_envelope_correct_view(account_id, envelope_id, correct_view_request) ⇒ nil

Revokes the correction view URL to the Envelope UI Revokes the correction view URL to the Envelope UI.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • correct_view_request (optional parameter)

Returns:

  • (nil) 


2536
2537
2538
2539
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2536

def delete_envelope_correct_view(, envelope_id, correct_view_request)
  delete_envelope_correct_view_with_http_info(, envelope_id,  correct_view_request)
  return nil
end

#delete_envelope_correct_view_with_http_info(account_id, envelope_id, correct_view_request) ⇒ Array<(nil, Fixnum, Hash)>

Revokes the correction view URL to the Envelope UI Revokes the correction view URL to the Envelope UI.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • correct_view_request (optional parameter)

Returns:

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

    nil, response status code and response headers



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2547

def delete_envelope_correct_view_with_http_info(, envelope_id, correct_view_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_correct_view ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_correct_view" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_correct_view" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(correct_view_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, 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: EnvelopesApi#delete_envelope_correct_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id) ⇒ nil

Deletes the delayed routing rules for the specified envelope workflow step.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step_id

Returns:

  • (nil) 


2590
2591
2592
2593
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2590

def delete_envelope_delayed_routing_definition(, envelope_id, workflow_step_id)
  delete_envelope_delayed_routing_definition_with_http_info(, envelope_id, workflow_step_id)
  return nil
end

#delete_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id) ⇒ Array<(nil, Fixnum, Hash)>

Deletes the delayed routing rules for the specified envelope workflow step.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step_id

Returns:

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

    nil, response status code and response headers



2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2601

def delete_envelope_delayed_routing_definition_with_http_info(, envelope_id, workflow_step_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_delayed_routing_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_delayed_routing_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_delayed_routing_definition" if envelope_id.nil?
  # verify the required parameter 'workflow_step_id' is set
  fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.delete_envelope_delayed_routing_definition" if workflow_step_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)

  # 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(:DELETE, 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: EnvelopesApi#delete_envelope_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_envelope_scheduled_sending_definition(account_id, envelope_id) ⇒ nil

Deletes the scheduled sending rules for the envelope’s workflow.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

  • (nil) 


2645
2646
2647
2648
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2645

def delete_envelope_scheduled_sending_definition(, envelope_id)
  delete_envelope_scheduled_sending_definition_with_http_info(, envelope_id)
  return nil
end

#delete_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id) ⇒ Array<(nil, Fixnum, Hash)>

Deletes the scheduled sending rules for the envelope&#39;s workflow.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    nil, response status code and response headers



2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2655

def delete_envelope_scheduled_sending_definition_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_scheduled_sending_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_scheduled_sending_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_scheduled_sending_definition" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(:DELETE, 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: EnvelopesApi#delete_envelope_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_envelope_transfer_rules(account_id, envelope_transfer_rule_id) ⇒ nil

Delete envelope transfer rules for an account. This method deletes an envelope transfer rule. Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_transfer_rule_id

Returns:

  • (nil) 


2697
2698
2699
2700
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2697

def delete_envelope_transfer_rules(, envelope_transfer_rule_id)
  delete_envelope_transfer_rules_with_http_info(, envelope_transfer_rule_id)
  return nil
end

#delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id) ⇒ Array<(nil, Fixnum, Hash)>

Delete envelope transfer rules for an account. This method deletes an envelope transfer rule. Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_transfer_rule_id

Returns:

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

    nil, response status code and response headers



2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2707

def delete_envelope_transfer_rules_with_http_info(, envelope_transfer_rule_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_transfer_rules ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_transfer_rules" if .nil?
  # verify the required parameter 'envelope_transfer_rule_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_transfer_rule_id' when calling EnvelopesApi.delete_envelope_transfer_rules" if envelope_transfer_rule_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeTransferRuleId' + '}', envelope_transfer_rule_id.to_s)

  # 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(:DELETE, 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: EnvelopesApi#delete_envelope_transfer_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_envelope_workflow_definition(account_id, envelope_id) ⇒ nil

Delete the workflow definition for an envelope. Deletes the specified envelope’s workflow definition if it has one.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

  • (nil) 


2749
2750
2751
2752
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2749

def delete_envelope_workflow_definition(, envelope_id)
  delete_envelope_workflow_definition_with_http_info(, envelope_id)
  return nil
end

#delete_envelope_workflow_definition_with_http_info(account_id, envelope_id) ⇒ Array<(nil, Fixnum, Hash)>

Delete the workflow definition for an envelope. Deletes the specified envelope&#39;s workflow definition if it has one.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    nil, response status code and response headers



2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2759

def delete_envelope_workflow_definition_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_workflow_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_workflow_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_workflow_definition" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(:DELETE, 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: EnvelopesApi#delete_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id) ⇒ nil

Deletes the envelope workflow step definition for an envelope’s workflow by step id.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step_id

Returns:

  • (nil) 


2802
2803
2804
2805
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2802

def delete_envelope_workflow_step_definition(, envelope_id, workflow_step_id)
  delete_envelope_workflow_step_definition_with_http_info(, envelope_id, workflow_step_id)
  return nil
end

#delete_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id) ⇒ Array<(nil, Fixnum, Hash)>

Deletes the envelope workflow step definition for an envelope&#39;s workflow by step id.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step_id

Returns:

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

    nil, response status code and response headers



2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2813

def delete_envelope_workflow_step_definition_with_http_info(, envelope_id, workflow_step_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_workflow_step_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_workflow_step_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_workflow_step_definition" if envelope_id.nil?
  # verify the required parameter 'workflow_step_id' is set
  fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.delete_envelope_workflow_step_definition" if workflow_step_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)

  # 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(:DELETE, 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: EnvelopesApi#delete_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_lock(account_id, envelope_id) ⇒ LockInformation

Deletes an envelope lock. Deletes the lock from the specified envelope. The ‘X-DocuSign-Edit` header must be included in the request.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



2857
2858
2859
2860
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2857

def delete_lock(, envelope_id)
  data, _status_code, _headers = delete_lock_with_http_info(, envelope_id)
  return data
end

#delete_lock_with_http_info(account_id, envelope_id) ⇒ Array<(LockInformation, Fixnum, Hash)>

Deletes an envelope lock. Deletes the lock from the specified envelope. The &#x60;X-DocuSign-Edit&#x60; header must be included in the request.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    LockInformation data, response status code and response headers



2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2867

def delete_lock_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_lock ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_lock" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_lock" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LockInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#delete_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_recipient(account_id, envelope_id, recipient_id) ⇒ Recipients

Deletes a recipient from an envelope. Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:



2911
2912
2913
2914
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2911

def delete_recipient(, envelope_id, recipient_id)
  data, _status_code, _headers = delete_recipient_with_http_info(, envelope_id, recipient_id)
  return data
end

#delete_recipient_with_http_info(account_id, envelope_id, recipient_id) ⇒ Array<(Recipients, Fixnum, Hash)>

Deletes a recipient from an envelope. Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:

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

    Recipients data, response status code and response headers



2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2922

def delete_recipient_with_http_info(, envelope_id, recipient_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_recipient ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_recipient" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_recipient" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.delete_recipient" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # 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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Recipients')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#delete_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_recipients(account_id, envelope_id, recipients) ⇒ Recipients

Deletes recipients from an envelope. Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the ‘recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipients (optional parameter)

Returns:



2968
2969
2970
2971
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2968

def delete_recipients(, envelope_id, recipients)
  data, _status_code, _headers = delete_recipients_with_http_info(, envelope_id,  recipients)
  return data
end

#delete_recipients_with_http_info(account_id, envelope_id, recipients) ⇒ Array<(Recipients, Fixnum, Hash)>

Deletes recipients from an envelope. Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the &#x60;recipientId&#x60; being used as the key for deleting recipients. If the envelope is &#x60;In Process&#x60;, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipients (optional parameter)

Returns:

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

    Recipients data, response status code and response headers



2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2979

def delete_recipients_with_http_info(, envelope_id, recipients)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_recipients ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_recipients" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_recipients" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(recipients)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Recipients')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#delete_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tabs(account_id, envelope_id, recipient_id, tabs) ⇒ Tabs

Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • tabs (optional parameter)

Returns:



3024
3025
3026
3027
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3024

def delete_tabs(, envelope_id, recipient_id, tabs)
  data, _status_code, _headers = delete_tabs_with_http_info(, envelope_id, recipient_id,  tabs)
  return data
end

#delete_tabs_with_http_info(account_id, envelope_id, recipient_id, tabs) ⇒ Array<(Tabs, Fixnum, Hash)>

Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • tabs (optional parameter)

Returns:

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

    Tabs data, response status code and response headers



3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3036

def delete_tabs_with_http_info(, envelope_id, recipient_id, tabs)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_tabs ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_tabs" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_tabs" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.delete_tabs" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # 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(tabs)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Tabs')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#delete_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_template_delayed_routing_definition(account_id, template_id, workflow_step_id) ⇒ nil

Deletes the delayed routing rules for the specified template workflow step.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step_id

Returns:

  • (nil) 


3082
3083
3084
3085
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3082

def delete_template_delayed_routing_definition(, template_id, workflow_step_id)
  delete_template_delayed_routing_definition_with_http_info(, template_id, workflow_step_id)
  return nil
end

#delete_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id) ⇒ Array<(nil, Fixnum, Hash)>

Deletes the delayed routing rules for the specified template workflow step.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step_id

Returns:

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

    nil, response status code and response headers



3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3093

def delete_template_delayed_routing_definition_with_http_info(, template_id, workflow_step_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_delayed_routing_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_delayed_routing_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_delayed_routing_definition" if template_id.nil?
  # verify the required parameter 'workflow_step_id' is set
  fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.delete_template_delayed_routing_definition" if workflow_step_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)

  # 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(:DELETE, 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: EnvelopesApi#delete_template_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_template_scheduled_sending_definition(account_id, template_id) ⇒ nil

Deletes the scheduled sending rules for the template’s workflow.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

Returns:

  • (nil) 


3137
3138
3139
3140
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3137

def delete_template_scheduled_sending_definition(, template_id)
  delete_template_scheduled_sending_definition_with_http_info(, template_id)
  return nil
end

#delete_template_scheduled_sending_definition_with_http_info(account_id, template_id) ⇒ Array<(nil, Fixnum, Hash)>

Deletes the scheduled sending rules for the template&#39;s workflow.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

Returns:

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

    nil, response status code and response headers



3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3147

def delete_template_scheduled_sending_definition_with_http_info(, template_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_scheduled_sending_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_scheduled_sending_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_scheduled_sending_definition" if template_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s)

  # 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(:DELETE, 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: EnvelopesApi#delete_template_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_template_workflow_definition(account_id, template_id) ⇒ nil

Delete the workflow definition for a template. Deletes the specified template’s workflow definition if it has one.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

Returns:

  • (nil) 


3189
3190
3191
3192
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3189

def delete_template_workflow_definition(, template_id)
  delete_template_workflow_definition_with_http_info(, template_id)
  return nil
end

#delete_template_workflow_definition_with_http_info(account_id, template_id) ⇒ Array<(nil, Fixnum, Hash)>

Delete the workflow definition for a template. Deletes the specified template&#39;s workflow definition if it has one.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

Returns:

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

    nil, response status code and response headers



3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3199

def delete_template_workflow_definition_with_http_info(, template_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_workflow_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_workflow_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_workflow_definition" if template_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s)

  # 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(:DELETE, 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: EnvelopesApi#delete_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_template_workflow_step_definition(account_id, template_id, workflow_step_id) ⇒ nil

Deletes the workflow step definition for an template’s workflow by step id.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step_id

Returns:

  • (nil) 


3242
3243
3244
3245
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3242

def delete_template_workflow_step_definition(, template_id, workflow_step_id)
  delete_template_workflow_step_definition_with_http_info(, template_id, workflow_step_id)
  return nil
end

#delete_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id) ⇒ Array<(nil, Fixnum, Hash)>

Deletes the workflow step definition for an template&#39;s workflow by step id.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step_id

Returns:

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

    nil, response status code and response headers



3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3253

def delete_template_workflow_step_definition_with_http_info(, template_id, workflow_step_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_workflow_step_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_workflow_step_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_workflow_step_definition" if template_id.nil?
  # verify the required parameter 'workflow_step_id' is set
  fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.delete_template_workflow_step_definition" if workflow_step_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)

  # 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(:DELETE, 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: EnvelopesApi#delete_template_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_templates_from_document(account_id, document_id, envelope_id, template_id) ⇒ nil

Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • template_id —

    The ID of the template being accessed.

Returns:

  • (nil) 


3299
3300
3301
3302
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3299

def delete_templates_from_document(, document_id, envelope_id, template_id)
  delete_templates_from_document_with_http_info(, document_id, envelope_id, template_id)
  return nil
end

#delete_templates_from_document_with_http_info(account_id, document_id, envelope_id, template_id) ⇒ Array<(nil, Fixnum, Hash)>

Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • template_id —

    The ID of the template being accessed.

Returns:

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

    nil, response status code and response headers



3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3311

def delete_templates_from_document_with_http_info(, document_id, envelope_id, template_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_templates_from_document ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_templates_from_document" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.delete_templates_from_document" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_templates_from_document" if envelope_id.nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_templates_from_document" if template_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)

  # 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(:DELETE, 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: EnvelopesApi#delete_templates_from_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_attachment(account_id, attachment_id, envelope_id) ⇒ File

Retrieves an attachment from the envelope. Retrieves an attachment from an envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • attachment_id
  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

  • (File) 


3358
3359
3360
3361
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3358

def get_attachment(, attachment_id, envelope_id)
  data, _status_code, _headers = get_attachment_with_http_info(, attachment_id, envelope_id)
  return data
end

#get_attachment_with_http_info(account_id, attachment_id, envelope_id) ⇒ Array<(File, Fixnum, Hash)>

Retrieves an attachment from the envelope. Retrieves an attachment from an envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • attachment_id
  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    File data, response status code and response headers



3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3369

def get_attachment_with_http_info(, attachment_id, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_attachment ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_attachment" if .nil?
  # verify the required parameter 'attachment_id' is set
  fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EnvelopesApi.get_attachment" if attachment_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_attachment" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])

  # 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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_attachments(account_id, envelope_id) ⇒ EnvelopeAttachmentsResult

Returns a list of attachments associated with the specified envelope Returns a list of attachments associated with a specified envelope

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



3414
3415
3416
3417
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3414

def get_attachments(, envelope_id)
  data, _status_code, _headers = get_attachments_with_http_info(, envelope_id)
  return data
end

#get_attachments_with_http_info(account_id, envelope_id) ⇒ Array<(EnvelopeAttachmentsResult, Fixnum, Hash)>

Returns a list of attachments associated with the specified envelope Returns a list of attachments associated with a specified envelope

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    EnvelopeAttachmentsResult data, response status code and response headers



3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3424

def get_attachments_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_attachments ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_attachments" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_attachments" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'EnvelopeAttachmentsResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chunked_upload(account_id, chunked_upload_id, options = DocuSign_eSign::GetChunkedUploadOptions.default) ⇒ ChunkedUploadResponse

Retrieves the current metadata of a ChunkedUpload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • chunked_upload_id
  • DocuSign_eSign::GetChunkedUploadOptions —

    Options for modifying the behavior of the function.

Returns:



3468
3469
3470
3471
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3468

def get_chunked_upload(, chunked_upload_id, options = DocuSign_eSign::GetChunkedUploadOptions.default)
  data, _status_code, _headers = get_chunked_upload_with_http_info(, chunked_upload_id, options)
  return data
end

#get_chunked_upload_with_http_info(account_id, chunked_upload_id, options = DocuSign_eSign::GetChunkedUploadOptions.default) ⇒ Array<(ChunkedUploadResponse, Fixnum, Hash)>

Retrieves the current metadata of a ChunkedUpload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • chunked_upload_id
  • DocuSign_eSign::GetChunkedUploadOptions —

    Options for modifying the behavior of the function.

Returns:

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

    ChunkedUploadResponse data, response status code and response headers



3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3479

def get_chunked_upload_with_http_info(, chunked_upload_id, options = DocuSign_eSign::GetChunkedUploadOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_chunked_upload ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_chunked_upload" if .nil?
  # verify the required parameter 'chunked_upload_id' is set
  fail ArgumentError, "Missing the required parameter 'chunked_upload_id' when calling EnvelopesApi.get_chunked_upload" if chunked_upload_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include'] = options.include if !options.include.nil?

  # 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 => 'ChunkedUploadResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_chunked_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_comments_transcript(account_id, envelope_id, options = DocuSign_eSign::GetCommentsTranscriptOptions.default) ⇒ File

Gets comment transcript for envelope and user Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the ‘accountSettingsInformation` object, set the `enableSigningExtensionComments` property to true).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::GetCommentsTranscriptOptions —

    Options for modifying the behavior of the function.

Returns:

  • (File) 


3524
3525
3526
3527
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3524

def get_comments_transcript(, envelope_id, options = DocuSign_eSign::GetCommentsTranscriptOptions.default)
  data, _status_code, _headers = get_comments_transcript_with_http_info(, envelope_id, options)
  return data
end

#get_comments_transcript_with_http_info(account_id, envelope_id, options = DocuSign_eSign::GetCommentsTranscriptOptions.default) ⇒ Array<(File, Fixnum, Hash)>

Gets comment transcript for envelope and user Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the &#x60;accountSettingsInformation&#x60; object, set the &#x60;enableSigningExtensionComments&#x60; property to true).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::GetCommentsTranscriptOptions —

    Options for modifying the behavior of the function.

Returns:

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

    File data, response status code and response headers



3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3535

def get_comments_transcript_with_http_info(, envelope_id, options = DocuSign_eSign::GetCommentsTranscriptOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_comments_transcript ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_comments_transcript" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_comments_transcript" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'encoding'] = options.encoding if !options.encoding.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])

  # 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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_comments_transcript\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_consumer_disclosure(account_id, envelope_id, lang_code, recipient_id, options = DocuSign_eSign::GetConsumerDisclosureOptions.default) ⇒ ConsumerDisclosure

Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • 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.

  • recipient_id —

    The ID of the recipient being accessed.

  • DocuSign_eSign::GetConsumerDisclosureOptions —

    Options for modifying the behavior of the function.

Returns:



3582
3583
3584
3585
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3582

def get_consumer_disclosure(, envelope_id, lang_code, recipient_id, options = DocuSign_eSign::GetConsumerDisclosureOptions.default)
  data, _status_code, _headers = get_consumer_disclosure_with_http_info(, envelope_id, lang_code, recipient_id, options)
  return data
end

#get_consumer_disclosure_default(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetConsumerDisclosureDefaultOptions.default) ⇒ ConsumerDisclosure

Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • DocuSign_eSign::GetConsumerDisclosureDefaultOptions —

    Options for modifying the behavior of the function.

Returns:



3645
3646
3647
3648
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3645

def get_consumer_disclosure_default(, envelope_id, recipient_id, options = DocuSign_eSign::GetConsumerDisclosureDefaultOptions.default)
  data, _status_code, _headers = get_consumer_disclosure_default_with_http_info(, envelope_id, recipient_id, options)
  return data
end

#get_consumer_disclosure_default_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetConsumerDisclosureDefaultOptions.default) ⇒ Array<(ConsumerDisclosure, Fixnum, Hash)>

Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • DocuSign_eSign::GetConsumerDisclosureDefaultOptions —

    Options for modifying the behavior of the function.

Returns:

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

    ConsumerDisclosure data, response status code and response headers



3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3657

def get_consumer_disclosure_default_with_http_info(, envelope_id, recipient_id, options = DocuSign_eSign::GetConsumerDisclosureDefaultOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_consumer_disclosure_default ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_consumer_disclosure_default" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_consumer_disclosure_default" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_consumer_disclosure_default" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'langCode'] = options.lang_code if !options.lang_code.nil?

  # 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 => 'ConsumerDisclosure')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_consumer_disclosure_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, options = DocuSign_eSign::GetConsumerDisclosureOptions.default) ⇒ Array<(ConsumerDisclosure, Fixnum, Hash)>

Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • 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.

  • recipient_id —

    The ID of the recipient being accessed.

  • DocuSign_eSign::GetConsumerDisclosureOptions —

    Options for modifying the behavior of the function.

Returns:

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

    ConsumerDisclosure data, response status code and response headers



3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3595

def get_consumer_disclosure_with_http_info(, envelope_id, lang_code, recipient_id, options = DocuSign_eSign::GetConsumerDisclosureOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_consumer_disclosure ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_consumer_disclosure" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_consumer_disclosure" if envelope_id.nil?
  # verify the required parameter 'lang_code' is set
  fail ArgumentError, "Missing the required parameter 'lang_code' when calling EnvelopesApi.get_consumer_disclosure" if lang_code.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_consumer_disclosure" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'langCode' + '}', lang_code.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'langCode'] = options.lang_code2 if !options.lang_code2.nil?

  # 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 => 'ConsumerDisclosure')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_consumer_disclosure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document(account_id, document_id, envelope_id, options = DocuSign_eSign::GetDocumentOptions.default) ⇒ File

Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the ‘documentId` parameter in the endpoint with `combined`. /accounts/accountId/envelopes/envelopeId/documents/combined

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::GetDocumentOptions —

    Options for modifying the behavior of the function.

Returns:

  • (File) 


3705
3706
3707
3708
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3705

def get_document(, document_id, envelope_id, options = DocuSign_eSign::GetDocumentOptions.default)
  data, _status_code, _headers = get_document_with_http_info(, document_id, envelope_id, options)
  return data
end

#get_document_page_image(account_id, document_id, envelope_id, page_number, options = DocuSign_eSign::GetDocumentPageImageOptions.default) ⇒ File

Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • page_number —

    The page number being accessed.

  • DocuSign_eSign::GetDocumentPageImageOptions —

    Options for modifying the behavior of the function.

Returns:

  • (File) 


3774
3775
3776
3777
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3774

def get_document_page_image(, document_id, envelope_id, page_number, options = DocuSign_eSign::GetDocumentPageImageOptions.default)
  data, _status_code, _headers = get_document_page_image_with_http_info(, document_id, envelope_id, page_number, options)
  return data
end

#get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, options = DocuSign_eSign::GetDocumentPageImageOptions.default) ⇒ Array<(File, Fixnum, Hash)>

Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • page_number —

    The page number being accessed.

  • DocuSign_eSign::GetDocumentPageImageOptions —

    Options for modifying the behavior of the function.

Returns:

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

    File data, response status code and response headers



3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3787

def get_document_page_image_with_http_info(, document_id, envelope_id, page_number, options = DocuSign_eSign::GetDocumentPageImageOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_document_page_image ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_document_page_image" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.get_document_page_image" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_document_page_image" if envelope_id.nil?
  # verify the required parameter 'page_number' is set
  fail ArgumentError, "Missing the required parameter 'page_number' when calling EnvelopesApi.get_document_page_image" if page_number.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'dpi'] = options.dpi if !options.dpi.nil?
  query_params[:'max_height'] = options.max_height if !options.max_height.nil?
  query_params[:'max_width'] = options.max_width if !options.max_width.nil?
  query_params[:'show_changes'] = options.show_changes if !options.show_changes.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/png'])

  # 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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_document_page_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_tabs(account_id, document_id, envelope_id, options = DocuSign_eSign::GetDocumentTabsOptions.default) ⇒ Tabs

Returns tabs on the document. Returns the tabs on the document specified by ‘documentId` in the envelope specified by `envelopeId`.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::GetDocumentTabsOptions —

    Options for modifying the behavior of the function.

Returns:



3840
3841
3842
3843
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3840

def get_document_tabs(, document_id, envelope_id, options = DocuSign_eSign::GetDocumentTabsOptions.default)
  data, _status_code, _headers = get_document_tabs_with_http_info(, document_id, envelope_id, options)
  return data
end

#get_document_tabs_with_http_info(account_id, document_id, envelope_id, options = DocuSign_eSign::GetDocumentTabsOptions.default) ⇒ Array<(Tabs, Fixnum, Hash)>

Returns tabs on the document. Returns the tabs on the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::GetDocumentTabsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    Tabs data, response status code and response headers



3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3852

def get_document_tabs_with_http_info(, document_id, envelope_id, options = DocuSign_eSign::GetDocumentTabsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_document_tabs ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_document_tabs" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.get_document_tabs" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_document_tabs" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
  query_params[:'page_numbers'] = options.page_numbers if !options.page_numbers.nil?

  # 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 => 'Tabs')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_with_http_info(account_id, document_id, envelope_id, options = DocuSign_eSign::GetDocumentOptions.default) ⇒ Array<(File, Fixnum, Hash)>

Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the &#x60;documentId&#x60; parameter in the endpoint with &#x60;combined&#x60;. /accounts/accountId/envelopes/envelopeId/documents/combined

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::GetDocumentOptions —

    Options for modifying the behavior of the function.

Returns:

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

    File data, response status code and response headers



3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3717

def get_document_with_http_info(, document_id, envelope_id, options = DocuSign_eSign::GetDocumentOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_document ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_document" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.get_document" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_document" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'certificate'] = options.certificate if !options.certificate.nil?
  query_params[:'documents_by_userid'] = options.documents_by_userid if !options.documents_by_userid.nil?
  query_params[:'encoding'] = options.encoding if !options.encoding.nil?
  query_params[:'encrypt'] = options.encrypt if !options.encrypt.nil?
  query_params[:'language'] = options.language if !options.language.nil?
  query_params[:'recipient_id'] = options.recipient_id if !options.recipient_id.nil?
  query_params[:'shared_user_id'] = options.shared_user_id if !options.shared_user_id.nil?
  query_params[:'show_changes'] = options.show_changes if !options.show_changes.nil?
  query_params[:'watermark'] = options.watermark if !options.watermark.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])

  # 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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_settings(account_id, envelope_id) ⇒ EmailSettings

Gets the email setting overrides for an envelope. Retrieves the email override settings for the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



3899
3900
3901
3902
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3899

def get_email_settings(, envelope_id)
  data, _status_code, _headers = get_email_settings_with_http_info(, envelope_id)
  return data
end

#get_email_settings_with_http_info(account_id, envelope_id) ⇒ Array<(EmailSettings, Fixnum, Hash)>

Gets the email setting overrides for an envelope. Retrieves the email override settings for the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    EmailSettings data, response status code and response headers



3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3909

def get_email_settings_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_email_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_email_settings" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_email_settings" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'EmailSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_email_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_envelope(account_id, envelope_id, options = DocuSign_eSign::GetEnvelopeOptions.default) ⇒ Envelope

Gets the status of a envelope. Retrieves the overall status for the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::GetEnvelopeOptions —

    Options for modifying the behavior of the function.

Returns:



3953
3954
3955
3956
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3953

def get_envelope(, envelope_id, options = DocuSign_eSign::GetEnvelopeOptions.default)
  data, _status_code, _headers = get_envelope_with_http_info(, envelope_id, options)
  return data
end

#get_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id) ⇒ DelayedRouting

Returns the delayed routing rules for an envelope’s workflow step definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step_id

Returns:



4011
4012
4013
4014
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4011

def get_envelope_delayed_routing_definition(, envelope_id, workflow_step_id)
  data, _status_code, _headers = get_envelope_delayed_routing_definition_with_http_info(, envelope_id, workflow_step_id)
  return data
end

#get_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id) ⇒ Array<(DelayedRouting, Fixnum, Hash)>

Returns the delayed routing rules for an envelope&#39;s workflow step definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step_id

Returns:

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

    DelayedRouting data, response status code and response headers



4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4022

def get_envelope_delayed_routing_definition_with_http_info(, envelope_id, workflow_step_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_delayed_routing_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_delayed_routing_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_delayed_routing_definition" if envelope_id.nil?
  # verify the required parameter 'workflow_step_id' is set
  fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.get_envelope_delayed_routing_definition" if workflow_step_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)

  # 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 => 'DelayedRouting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_envelope_doc_gen_form_fields(account_id, envelope_id) ⇒ DocGenFormFieldResponse

Returns formfields for an envelope

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



4067
4068
4069
4070
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4067

def get_envelope_doc_gen_form_fields(, envelope_id)
  data, _status_code, _headers = get_envelope_doc_gen_form_fields_with_http_info(, envelope_id)
  return data
end

#get_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id) ⇒ Array<(DocGenFormFieldResponse, Fixnum, Hash)>

Returns formfields for an envelope

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    DocGenFormFieldResponse data, response status code and response headers



4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4077

def get_envelope_doc_gen_form_fields_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_doc_gen_form_fields ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_doc_gen_form_fields" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_doc_gen_form_fields" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'DocGenFormFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_doc_gen_form_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_envelope_document_html_definitions(account_id, document_id, envelope_id) ⇒ DocumentHtmlDefinitionOriginals

Get the Original HTML Definition used to generate the Responsive HTML for a given document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



4121
4122
4123
4124
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4121

def get_envelope_document_html_definitions(, document_id, envelope_id)
  data, _status_code, _headers = get_envelope_document_html_definitions_with_http_info(, document_id, envelope_id)
  return data
end

#get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id) ⇒ Array<(DocumentHtmlDefinitionOriginals, Fixnum, Hash)>

Get the Original HTML Definition used to generate the Responsive HTML for a given document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4132

def get_envelope_document_html_definitions_with_http_info(, document_id, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_document_html_definitions ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_document_html_definitions" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.get_envelope_document_html_definitions" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_document_html_definitions" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'DocumentHtmlDefinitionOriginals')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_document_html_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_envelope_html_definitions(account_id, envelope_id) ⇒ DocumentHtmlDefinitionOriginals

Get the Original HTML Definition used to generate the Responsive HTML for the envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



4177
4178
4179
4180
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4177

def get_envelope_html_definitions(, envelope_id)
  data, _status_code, _headers = get_envelope_html_definitions_with_http_info(, envelope_id)
  return data
end

#get_envelope_html_definitions_with_http_info(account_id, envelope_id) ⇒ Array<(DocumentHtmlDefinitionOriginals, Fixnum, Hash)>

Get the Original HTML Definition used to generate the Responsive HTML for the envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4187

def get_envelope_html_definitions_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_html_definitions ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_html_definitions" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_html_definitions" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'DocumentHtmlDefinitionOriginals')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_html_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_envelope_scheduled_sending_definition(account_id, envelope_id) ⇒ ScheduledSending

Returns the scheduled sending rules for an envelope’s workflow definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



4230
4231
4232
4233
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4230

def get_envelope_scheduled_sending_definition(, envelope_id)
  data, _status_code, _headers = get_envelope_scheduled_sending_definition_with_http_info(, envelope_id)
  return data
end

#get_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id) ⇒ Array<(ScheduledSending, Fixnum, Hash)>

Returns the scheduled sending rules for an envelope&#39;s workflow definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    ScheduledSending data, response status code and response headers



4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4240

def get_envelope_scheduled_sending_definition_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_scheduled_sending_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_scheduled_sending_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_scheduled_sending_definition" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'ScheduledSending')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_envelope_transfer_rules(account_id, options = DocuSign_eSign::GetEnvelopeTransferRulesOptions.default) ⇒ EnvelopeTransferRuleInformation

Returns a list of envelope transfer rules in the specified account. This method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::GetEnvelopeTransferRulesOptions —

    Options for modifying the behavior of the function.

Returns:



4283
4284
4285
4286
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4283

def get_envelope_transfer_rules(, options = DocuSign_eSign::GetEnvelopeTransferRulesOptions.default)
  data, _status_code, _headers = get_envelope_transfer_rules_with_http_info(, options)
  return data
end

#get_envelope_transfer_rules_with_http_info(account_id, options = DocuSign_eSign::GetEnvelopeTransferRulesOptions.default) ⇒ Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>

Returns a list of envelope transfer rules in the specified account. This method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::GetEnvelopeTransferRulesOptions —

    Options for modifying the behavior of the function.

Returns:



4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4293

def get_envelope_transfer_rules_with_http_info(, options = DocuSign_eSign::GetEnvelopeTransferRulesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_transfer_rules ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_transfer_rules" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?

  # 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 => 'EnvelopeTransferRuleInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_transfer_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_envelope_with_http_info(account_id, envelope_id, options = DocuSign_eSign::GetEnvelopeOptions.default) ⇒ Array<(Envelope, Fixnum, Hash)>

Gets the status of a envelope. Retrieves the overall status for the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::GetEnvelopeOptions —

    Options for modifying the behavior of the function.

Returns:

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

    Envelope data, response status code and response headers



3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3964

def get_envelope_with_http_info(, envelope_id, options = DocuSign_eSign::GetEnvelopeOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'advanced_update'] = options.advanced_update if !options.advanced_update.nil?
  query_params[:'include'] = options.include if !options.include.nil?
  query_params[:'include_anchor_tab_locations'] = options.include_anchor_tab_locations if !options.include_anchor_tab_locations.nil?

  # 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 => 'Envelope')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_envelope_workflow_definition(account_id, envelope_id) ⇒ Workflow

Returns the workflow definition for an envelope. Returns an envelope’s workflow definition if the envelope specified by ‘envelopeId` has one.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



4336
4337
4338
4339
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4336

def get_envelope_workflow_definition(, envelope_id)
  data, _status_code, _headers = get_envelope_workflow_definition_with_http_info(, envelope_id)
  return data
end

#get_envelope_workflow_definition_with_http_info(account_id, envelope_id) ⇒ Array<(Workflow, Fixnum, Hash)>

Returns the workflow definition for an envelope. Returns an envelope&#39;s workflow definition if the envelope specified by &#x60;envelopeId&#x60; has one.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    Workflow data, response status code and response headers



4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4346

def get_envelope_workflow_definition_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_workflow_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_workflow_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_workflow_definition" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id) ⇒ WorkflowStep

Returns the workflow step definition for an envelope by step id.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step_id

Returns:



4390
4391
4392
4393
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4390

def get_envelope_workflow_step_definition(, envelope_id, workflow_step_id)
  data, _status_code, _headers = get_envelope_workflow_step_definition_with_http_info(, envelope_id, workflow_step_id)
  return data
end

#get_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id) ⇒ Array<(WorkflowStep, Fixnum, Hash)>

Returns the workflow step definition for an envelope by step id.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step_id

Returns:

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

    WorkflowStep data, response status code and response headers



4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4401

def get_envelope_workflow_step_definition_with_http_info(, envelope_id, workflow_step_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_workflow_step_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_workflow_step_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_workflow_step_definition" if envelope_id.nil?
  # verify the required parameter 'workflow_step_id' is set
  fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.get_envelope_workflow_step_definition" if workflow_step_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)

  # 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 => 'WorkflowStep')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_form_data(account_id, envelope_id) ⇒ EnvelopeFormData

Returns envelope form data for an existing envelope. This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. Note: To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account. ### Related topics - [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



4446
4447
4448
4449
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4446

def get_form_data(, envelope_id)
  data, _status_code, _headers = get_form_data_with_http_info(, envelope_id)
  return data
end

#get_form_data_with_http_info(account_id, envelope_id) ⇒ Array<(EnvelopeFormData, Fixnum, Hash)>

Returns envelope form data for an existing envelope. This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. Note: To use this feature, the Sending Setting &quot;Allow sender to download form data&quot; must be enabled for the account. ### Related topics - [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    EnvelopeFormData data, response status code and response headers



4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4456

def get_form_data_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_form_data ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_form_data" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_form_data" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'EnvelopeFormData')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_form_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_lock(account_id, envelope_id) ⇒ LockInformation

Gets envelope lock information. Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the ‘X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



4499
4500
4501
4502
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4499

def get_lock(, envelope_id)
  data, _status_code, _headers = get_lock_with_http_info(, envelope_id)
  return data
end

#get_lock_with_http_info(account_id, envelope_id) ⇒ Array<(LockInformation, Fixnum, Hash)>

Gets envelope lock information. Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the &#x60;X-DocuSign-Edit&#x60; header and additional lock information is included in the response. This allows users to recover a lost editing session token and the &#x60;X-DocuSign-Edit&#x60; header.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    LockInformation data, response status code and response headers



4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4509

def get_lock_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_lock ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_lock" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_lock" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'LockInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notification_settings(account_id, envelope_id) ⇒ Notification

Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



4552
4553
4554
4555
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4552

def get_notification_settings(, envelope_id)
  data, _status_code, _headers = get_notification_settings_with_http_info(, envelope_id)
  return data
end

#get_notification_settings_with_http_info(account_id, envelope_id) ⇒ Array<(Notification, Fixnum, Hash)>

Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    Notification data, response status code and response headers



4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4562

def get_notification_settings_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_notification_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_notification_settings" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_notification_settings" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'Notification')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_notification_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_tabs(account_id, document_id, envelope_id, page_number) ⇒ Tabs

Returns tabs on the specified page. Returns the tabs from the page specified by ‘pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • page_number —

    The page number being accessed.

Returns:



4607
4608
4609
4610
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4607

def get_page_tabs(, document_id, envelope_id, page_number)
  data, _status_code, _headers = get_page_tabs_with_http_info(, document_id, envelope_id, page_number)
  return data
end

#get_page_tabs_with_http_info(account_id, document_id, envelope_id, page_number) ⇒ Array<(Tabs, Fixnum, Hash)>

Returns tabs on the specified page. Returns the tabs from the page specified by &#x60;pageNumber&#x60; of the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • page_number —

    The page number being accessed.

Returns:

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

    Tabs data, response status code and response headers



4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4619

def get_page_tabs_with_http_info(, document_id, envelope_id, page_number)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_page_tabs ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_page_tabs" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.get_page_tabs" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_page_tabs" if envelope_id.nil?
  # verify the required parameter 'page_number' is set
  fail ArgumentError, "Missing the required parameter 'page_number' when calling EnvelopesApi.get_page_tabs" if page_number.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # 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 => 'Tabs')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_page_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pages(account_id, document_id, envelope_id, options = DocuSign_eSign::GetPagesOptions.default) ⇒ PageImages

Returns document page image(s) based on input. Returns images of the pages in a document for display based on the parameters that you specify.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::GetPagesOptions —

    Options for modifying the behavior of the function.

Returns:



4668
4669
4670
4671
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4668

def get_pages(, document_id, envelope_id, options = DocuSign_eSign::GetPagesOptions.default)
  data, _status_code, _headers = get_pages_with_http_info(, document_id, envelope_id, options)
  return data
end

#get_pages_with_http_info(account_id, document_id, envelope_id, options = DocuSign_eSign::GetPagesOptions.default) ⇒ Array<(PageImages, Fixnum, Hash)>

Returns document page image(s) based on input. Returns images of the pages in a document for display based on the parameters that you specify.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::GetPagesOptions —

    Options for modifying the behavior of the function.

Returns:

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

    PageImages data, response status code and response headers



4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4680

def get_pages_with_http_info(, document_id, envelope_id, options = DocuSign_eSign::GetPagesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_pages ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_pages" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.get_pages" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_pages" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'dpi'] = options.dpi if !options.dpi.nil?
  query_params[:'max_height'] = options.max_height if !options.max_height.nil?
  query_params[:'max_width'] = options.max_width if !options.max_width.nil?
  query_params[:'nocache'] = options.nocache if !options.nocache.nil?
  query_params[:'show_changes'] = options.show_changes if !options.show_changes.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?

  # 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 => 'PageImages')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recipient_document_visibility(account_id, envelope_id, recipient_id) ⇒ DocumentVisibilityList

Returns document visibility for the recipients This method returns information about document visibility for a recipient.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:



4733
4734
4735
4736
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4733

def get_recipient_document_visibility(, envelope_id, recipient_id)
  data, _status_code, _headers = get_recipient_document_visibility_with_http_info(, envelope_id, recipient_id)
  return data
end

#get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id) ⇒ Array<(DocumentVisibilityList, Fixnum, Hash)>

Returns document visibility for the recipients This method returns information about document visibility for a recipient.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:

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

    DocumentVisibilityList data, response status code and response headers



4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4744

def get_recipient_document_visibility_with_http_info(, envelope_id, recipient_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_recipient_document_visibility ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_recipient_document_visibility" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_recipient_document_visibility" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_recipient_document_visibility" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # 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 => 'DocumentVisibilityList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_recipient_document_visibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recipient_initials_image(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientInitialsImageOptions.default) ⇒ File

Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user’s user id and the user must be a member of the account. The ‘signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • DocuSign_eSign::GetRecipientInitialsImageOptions —

    Options for modifying the behavior of the function.

Returns:

  • (File) 


4791
4792
4793
4794
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4791

def get_recipient_initials_image(, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientInitialsImageOptions.default)
  data, _status_code, _headers = get_recipient_initials_image_with_http_info(, envelope_id, recipient_id, options)
  return data
end

#get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientInitialsImageOptions.default) ⇒ Array<(File, Fixnum, Hash)>

Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user&#39;s user id and the user must be a member of the account. The &#x60;signatureIdOrName&#x60; paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: &quot;Bob Smith&quot; to &quot;Bob%20Smith&quot; Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • DocuSign_eSign::GetRecipientInitialsImageOptions —

    Options for modifying the behavior of the function.

Returns:

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

    File data, response status code and response headers



4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4803

def get_recipient_initials_image_with_http_info(, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientInitialsImageOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_recipient_initials_image ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_recipient_initials_image" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_recipient_initials_image" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_recipient_initials_image" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include_chrome'] = options.include_chrome if !options.include_chrome.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/gif'])

  # 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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_recipient_initials_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recipient_signature(account_id, envelope_id, recipient_id) ⇒ UserSignature

Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:



4850
4851
4852
4853
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4850

def get_recipient_signature(, envelope_id, recipient_id)
  data, _status_code, _headers = get_recipient_signature_with_http_info(, envelope_id, recipient_id)
  return data
end

#get_recipient_signature_image(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientSignatureImageOptions.default) ⇒ File

Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account. The ‘signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don’t properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • DocuSign_eSign::GetRecipientSignatureImageOptions —

    Options for modifying the behavior of the function.

Returns:

  • (File) 


4908
4909
4910
4911
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4908

def get_recipient_signature_image(, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientSignatureImageOptions.default)
  data, _status_code, _headers = get_recipient_signature_image_with_http_info(, envelope_id, recipient_id, options)
  return data
end

#get_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientSignatureImageOptions.default) ⇒ Array<(File, Fixnum, Hash)>

Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the account. The &#x60;signatureIdOrName&#x60; parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), since some names contain characters that don&#39;t properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: &quot;Bob Smith&quot; to &quot;Bob%20Smith&quot; Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • DocuSign_eSign::GetRecipientSignatureImageOptions —

    Options for modifying the behavior of the function.

Returns:

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

    File data, response status code and response headers



4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4920

def get_recipient_signature_image_with_http_info(, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientSignatureImageOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_recipient_signature_image ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_recipient_signature_image" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_recipient_signature_image" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_recipient_signature_image" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include_chrome'] = options.include_chrome if !options.include_chrome.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/gif'])

  # 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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_recipient_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recipient_signature_with_http_info(account_id, envelope_id, recipient_id) ⇒ Array<(UserSignature, Fixnum, Hash)>

Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:

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

    UserSignature data, response status code and response headers



4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4861

def get_recipient_signature_with_http_info(, envelope_id, recipient_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_recipient_signature ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_recipient_signature" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_recipient_signature" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_recipient_signature" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # 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 => 'UserSignature')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_recipient_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tabs_blob(account_id, envelope_id) ⇒ nil

Get encrypted tabs for envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

  • (nil) 


4966
4967
4968
4969
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4966

def get_tabs_blob(, envelope_id)
  get_tabs_blob_with_http_info(, envelope_id)
  return nil
end

#get_tabs_blob_with_http_info(account_id, envelope_id) ⇒ Array<(nil, Fixnum, Hash)>

Get encrypted tabs for envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    nil, response status code and response headers



4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4976

def get_tabs_blob_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_tabs_blob ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_tabs_blob" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_tabs_blob" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_tabs_blob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_template_delayed_routing_definition(account_id, template_id, workflow_step_id) ⇒ DelayedRouting

Returns the delayed routing rules for a template’s workflow step definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step_id

Returns:



5019
5020
5021
5022
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5019

def get_template_delayed_routing_definition(, template_id, workflow_step_id)
  data, _status_code, _headers = get_template_delayed_routing_definition_with_http_info(, template_id, workflow_step_id)
  return data
end

#get_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id) ⇒ Array<(DelayedRouting, Fixnum, Hash)>

Returns the delayed routing rules for a template&#39;s workflow step definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step_id

Returns:

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

    DelayedRouting data, response status code and response headers



5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5030

def get_template_delayed_routing_definition_with_http_info(, template_id, workflow_step_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_delayed_routing_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_delayed_routing_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_delayed_routing_definition" if template_id.nil?
  # verify the required parameter 'workflow_step_id' is set
  fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.get_template_delayed_routing_definition" if workflow_step_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)

  # 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 => 'DelayedRouting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_template_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_template_recipient_document_visibility(account_id, recipient_id, template_id) ⇒ DocumentVisibilityList

Returns document visibility for the recipients This method returns information about document visibility for a template recipient.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • recipient_id —

    The ID of the recipient being accessed.

  • template_id —

    The ID of the template being accessed.

Returns:



5076
5077
5078
5079
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5076

def get_template_recipient_document_visibility(, recipient_id, template_id)
  data, _status_code, _headers = get_template_recipient_document_visibility_with_http_info(, recipient_id, template_id)
  return data
end

#get_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id) ⇒ Array<(DocumentVisibilityList, Fixnum, Hash)>

Returns document visibility for the recipients This method returns information about document visibility for a template recipient.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • recipient_id —

    The ID of the recipient being accessed.

  • template_id —

    The ID of the template being accessed.

Returns:

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

    DocumentVisibilityList data, response status code and response headers



5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5087

def get_template_recipient_document_visibility_with_http_info(, recipient_id, template_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_recipient_document_visibility ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_recipient_document_visibility" if .nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.get_template_recipient_document_visibility" if recipient_id.nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_recipient_document_visibility" if template_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)

  # 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 => 'DocumentVisibilityList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_template_recipient_document_visibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_template_scheduled_sending_definition(account_id, template_id) ⇒ ScheduledSending

Returns the scheduled sending rules for a template’s workflow definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

Returns:



5132
5133
5134
5135
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5132

def get_template_scheduled_sending_definition(, template_id)
  data, _status_code, _headers = get_template_scheduled_sending_definition_with_http_info(, template_id)
  return data
end

#get_template_scheduled_sending_definition_with_http_info(account_id, template_id) ⇒ Array<(ScheduledSending, Fixnum, Hash)>

Returns the scheduled sending rules for a template&#39;s workflow definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

Returns:

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

    ScheduledSending data, response status code and response headers



5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5142

def get_template_scheduled_sending_definition_with_http_info(, template_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_scheduled_sending_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_scheduled_sending_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_scheduled_sending_definition" if template_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s)

  # 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 => 'ScheduledSending')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_template_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_template_workflow_definition(account_id, template_id) ⇒ Workflow

Returns the workflow definition for a template. Returns template’s workflow definition if the template specified by ‘templateId` has one.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

Returns:



5185
5186
5187
5188
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5185

def get_template_workflow_definition(, template_id)
  data, _status_code, _headers = get_template_workflow_definition_with_http_info(, template_id)
  return data
end

#get_template_workflow_definition_with_http_info(account_id, template_id) ⇒ Array<(Workflow, Fixnum, Hash)>

Returns the workflow definition for a template. Returns template&#39;s workflow definition if the template specified by &#x60;templateId&#x60; has one.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

Returns:

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

    Workflow data, response status code and response headers



5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5195

def get_template_workflow_definition_with_http_info(, template_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_workflow_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_workflow_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_workflow_definition" if template_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s)

  # 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 => 'Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_template_workflow_step_definition(account_id, template_id, workflow_step_id) ⇒ WorkflowStep

Returns the workflow step definition for a template by step id.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step_id

Returns:



5239
5240
5241
5242
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5239

def get_template_workflow_step_definition(, template_id, workflow_step_id)
  data, _status_code, _headers = get_template_workflow_step_definition_with_http_info(, template_id, workflow_step_id)
  return data
end

#get_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id) ⇒ Array<(WorkflowStep, Fixnum, Hash)>

Returns the workflow step definition for a template by step id.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step_id

Returns:

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

    WorkflowStep data, response status code and response headers



5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5250

def get_template_workflow_step_definition_with_http_info(, template_id, workflow_step_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_workflow_step_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_workflow_step_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_workflow_step_definition" if template_id.nil?
  # verify the required parameter 'workflow_step_id' is set
  fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.get_template_workflow_step_definition" if workflow_step_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)

  # 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 => 'WorkflowStep')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#get_template_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_audit_events(account_id, envelope_id) ⇒ EnvelopeAuditEventResponse

Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



5295
5296
5297
5298
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5295

def list_audit_events(, envelope_id)
  data, _status_code, _headers = list_audit_events_with_http_info(, envelope_id)
  return data
end

#list_audit_events_with_http_info(account_id, envelope_id) ⇒ Array<(EnvelopeAuditEventResponse, Fixnum, Hash)>

Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    EnvelopeAuditEventResponse data, response status code and response headers



5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5305

def list_audit_events_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.list_audit_events ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.list_audit_events" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_audit_events" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'EnvelopeAuditEventResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#list_audit_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_custom_fields(account_id, envelope_id) ⇒ CustomFieldsEnvelope

Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



5348
5349
5350
5351
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5348

def list_custom_fields(, envelope_id)
  data, _status_code, _headers = list_custom_fields_with_http_info(, envelope_id)
  return data
end

#list_custom_fields_with_http_info(account_id, envelope_id) ⇒ Array<(CustomFieldsEnvelope, Fixnum, Hash)>

Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    CustomFieldsEnvelope data, response status code and response headers



5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5358

def list_custom_fields_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.list_custom_fields ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.list_custom_fields" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_custom_fields" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'CustomFieldsEnvelope')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#list_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_document_fields(account_id, document_id, envelope_id) ⇒ DocumentFieldsInformation

Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



5402
5403
5404
5405
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5402

def list_document_fields(, document_id, envelope_id)
  data, _status_code, _headers = list_document_fields_with_http_info(, document_id, envelope_id)
  return data
end

#list_document_fields_with_http_info(account_id, document_id, envelope_id) ⇒ Array<(DocumentFieldsInformation, Fixnum, Hash)>

Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    DocumentFieldsInformation data, response status code and response headers



5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5413

def list_document_fields_with_http_info(, document_id, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.list_document_fields ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.list_document_fields" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.list_document_fields" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_document_fields" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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 => 'DocumentFieldsInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#list_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_documents(account_id, envelope_id, options = DocuSign_eSign::ListDocumentsOptions.default) ⇒ EnvelopeDocumentsResult

Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::ListDocumentsOptions —

    Options for modifying the behavior of the function.

Returns:



5459
5460
5461
5462
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5459

def list_documents(, envelope_id, options = DocuSign_eSign::ListDocumentsOptions.default)
  data, _status_code, _headers = list_documents_with_http_info(, envelope_id, options)
  return data
end

#list_documents_with_http_info(account_id, envelope_id, options = DocuSign_eSign::ListDocumentsOptions.default) ⇒ Array<(EnvelopeDocumentsResult, Fixnum, Hash)>

Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::ListDocumentsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    EnvelopeDocumentsResult data, response status code and response headers



5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5470

def list_documents_with_http_info(, envelope_id, options = DocuSign_eSign::ListDocumentsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.list_documents ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.list_documents" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_documents" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'documents_by_userid'] = options.documents_by_userid if !options.documents_by_userid.nil?
  query_params[:'include_docgen_formfields'] = options.include_docgen_formfields if !options.include_docgen_formfields.nil?
  query_params[:'include_document_size'] = options.include_document_size if !options.include_document_size.nil?
  query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
  query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
  query_params[:'recipient_id'] = options.recipient_id if !options.recipient_id.nil?
  query_params[:'shared_user_id'] = options.shared_user_id if !options.shared_user_id.nil?

  # 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 => 'EnvelopeDocumentsResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#list_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_recipients(account_id, envelope_id, options = DocuSign_eSign::ListRecipientsOptions.default) ⇒ Recipients

Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The ‘currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::ListRecipientsOptions —

    Options for modifying the behavior of the function.

Returns:



5521
5522
5523
5524
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5521

def list_recipients(, envelope_id, options = DocuSign_eSign::ListRecipientsOptions.default)
  data, _status_code, _headers = list_recipients_with_http_info(, envelope_id, options)
  return data
end

#list_recipients_with_http_info(account_id, envelope_id, options = DocuSign_eSign::ListRecipientsOptions.default) ⇒ Array<(Recipients, Fixnum, Hash)>

Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The &#x60;currentRoutingOrder&#x60; property of the response contains the &#x60;routingOrder&#x60; value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::ListRecipientsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    Recipients data, response status code and response headers



5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5532

def list_recipients_with_http_info(, envelope_id, options = DocuSign_eSign::ListRecipientsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.list_recipients ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.list_recipients" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_recipients" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include_anchor_tab_locations'] = options.include_anchor_tab_locations if !options.include_anchor_tab_locations.nil?
  query_params[:'include_extended'] = options.include_extended if !options.include_extended.nil?
  query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
  query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?

  # 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 => 'Recipients')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#list_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_status(account_id, envelope_ids_request, options = DocuSign_eSign::ListStatusOptions.default) ⇒ EnvelopesInformation

Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_ids_request (optional parameter)
  • DocuSign_eSign::ListStatusOptions —

    Options for modifying the behavior of the function.

Returns:



5580
5581
5582
5583
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5580

def list_status(, envelope_ids_request, options = DocuSign_eSign::ListStatusOptions.default)
  data, _status_code, _headers = list_status_with_http_info(,  envelope_ids_request, options)
  return data
end

#list_status_changes(account_id, options = DocuSign_eSign::ListStatusChangesOptions.default) ⇒ EnvelopesInformation

Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the ‘envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for "any status change" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` &mdash; the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of "`Created`,`Sent`", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::ListStatusChangesOptions —

    Options for modifying the behavior of the function.

Returns:



5644
5645
5646
5647
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5644

def list_status_changes(, options = DocuSign_eSign::ListStatusChangesOptions.default)
  data, _status_code, _headers = list_status_changes_with_http_info(, options)
  return data
end

#list_status_changes_with_http_info(account_id, options = DocuSign_eSign::ListStatusChangesOptions.default) ⇒ Array<(EnvelopesInformation, Fixnum, Hash)>

Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the &#x60;envelopeIds&#x60; or &#x60;transactionIds&#x60; properties), you must add a set the &#x60;from_date&#x60; property in the request. Getting envelope status using &#x60;transactionIds&#x60; is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for &quot;any status change&quot; instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (&#x60;from_to_status&#x60;) set to &#x60;Delivered&#x60; &amp;mdash; the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of &#x60;Delivered&#x60; and a status of &quot;&#x60;Created&#x60;,&#x60;Sent&#x60;&quot;, DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of &#x60;Created&#x60; or &#x60;Sent&#x60;, and since an envelope that has been delivered can never have a status of &#x60;Created&#x60; or &#x60;Sent&#x60;, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::ListStatusChangesOptions —

    Options for modifying the behavior of the function.

Returns:

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

    EnvelopesInformation data, response status code and response headers



5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5654

def list_status_changes_with_http_info(, options = DocuSign_eSign::ListStatusChangesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.list_status_changes ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.list_status_changes" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'ac_status'] = options.ac_status if !options.ac_status.nil?
  query_params[:'block'] = options.block if !options.block.nil?
  query_params[:'cdse_mode'] = options.cdse_mode if !options.cdse_mode.nil?
  query_params[:'continuation_token'] = options.continuation_token if !options.continuation_token.nil?
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'custom_field'] = options.custom_field if !options.custom_field.nil?
  query_params[:'email'] = options.email if !options.email.nil?
  query_params[:'envelope_ids'] = options.envelope_ids if !options.envelope_ids.nil?
  query_params[:'exclude'] = options.exclude if !options.exclude.nil?
  query_params[:'folder_ids'] = options.folder_ids if !options.folder_ids.nil?
  query_params[:'folder_types'] = options.folder_types if !options.folder_types.nil?
  query_params[:'from_date'] = options.from_date if !options.from_date.nil?
  query_params[:'from_to_status'] = options.from_to_status if !options.from_to_status.nil?
  query_params[:'include'] = options.include if !options.include.nil?
  query_params[:'include_purge_information'] = options.include_purge_information if !options.include_purge_information.nil?
  query_params[:'intersecting_folder_ids'] = options.intersecting_folder_ids if !options.intersecting_folder_ids.nil?
  query_params[:'last_queried_date'] = options.last_queried_date if !options.last_queried_date.nil?
  query_params[:'order'] = options.order if !options.order.nil?
  query_params[:'order_by'] = options.order_by if !options.order_by.nil?
  query_params[:'powerformids'] = options.powerformids if !options.powerformids.nil?
  query_params[:'query_budget'] = options.query_budget if !options.query_budget.nil?
  query_params[:'requester_date_format'] = options.requester_date_format if !options.requester_date_format.nil?
  query_params[:'search_mode'] = options.search_mode if !options.search_mode.nil?
  query_params[:'search_text'] = options.search_text if !options.search_text.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
  query_params[:'status'] = options.status if !options.status.nil?
  query_params[:'to_date'] = options.to_date if !options.to_date.nil?
  query_params[:'transaction_ids'] = options.transaction_ids if !options.transaction_ids.nil?
  query_params[:'user_filter'] = options.user_filter if !options.user_filter.nil?
  query_params[:'user_id'] = options.user_id if !options.user_id.nil?
  query_params[:'user_name'] = options.user_name if !options.user_name.nil?

  # 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 => 'EnvelopesInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#list_status_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_status_with_http_info(account_id, envelope_ids_request, options = DocuSign_eSign::ListStatusOptions.default) ⇒ Array<(EnvelopesInformation, Fixnum, Hash)>

Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_ids_request (optional parameter)
  • DocuSign_eSign::ListStatusOptions —

    Options for modifying the behavior of the function.

Returns:

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

    EnvelopesInformation data, response status code and response headers



5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5591

def list_status_with_http_info(, envelope_ids_request, options = DocuSign_eSign::ListStatusOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.list_status ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.list_status" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/status".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'ac_status'] = options.ac_status if !options.ac_status.nil?
  query_params[:'block'] = options.block if !options.block.nil?
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'email'] = options.email if !options.email.nil?
  query_params[:'envelope_ids'] = options.envelope_ids if !options.envelope_ids.nil?
  query_params[:'from_date'] = options.from_date if !options.from_date.nil?
  query_params[:'from_to_status'] = options.from_to_status if !options.from_to_status.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
  query_params[:'status'] = options.status if !options.status.nil?
  query_params[:'to_date'] = options.to_date if !options.to_date.nil?
  query_params[:'transaction_ids'] = options.transaction_ids if !options.transaction_ids.nil?
  query_params[:'user_name'] = options.user_name if !options.user_name.nil?

  # 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(envelope_ids_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EnvelopesInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#list_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_tabs(account_id, envelope_id, recipient_id, options = DocuSign_eSign::ListTabsOptions.default) ⇒ Tabs

Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • DocuSign_eSign::ListTabsOptions —

    Options for modifying the behavior of the function.

Returns:



5728
5729
5730
5731
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5728

def list_tabs(, envelope_id, recipient_id, options = DocuSign_eSign::ListTabsOptions.default)
  data, _status_code, _headers = list_tabs_with_http_info(, envelope_id, recipient_id, options)
  return data
end

#list_tabs_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::ListTabsOptions.default) ⇒ Array<(Tabs, Fixnum, Hash)>

Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • DocuSign_eSign::ListTabsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    Tabs data, response status code and response headers



5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5740

def list_tabs_with_http_info(, envelope_id, recipient_id, options = DocuSign_eSign::ListTabsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.list_tabs ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.list_tabs" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_tabs" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.list_tabs" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include_anchor_tab_locations'] = options.include_anchor_tab_locations if !options.include_anchor_tab_locations.nil?
  query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?

  # 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 => 'Tabs')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#list_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_templates(account_id, envelope_id, options = DocuSign_eSign::ListTemplatesOptions.default) ⇒ TemplateInformation

Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::ListTemplatesOptions —

    Options for modifying the behavior of the function.

Returns:



5788
5789
5790
5791
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5788

def list_templates(, envelope_id, options = DocuSign_eSign::ListTemplatesOptions.default)
  data, _status_code, _headers = list_templates_with_http_info(, envelope_id, options)
  return data
end

#list_templates_for_document(account_id, document_id, envelope_id, options = DocuSign_eSign::ListTemplatesForDocumentOptions.default) ⇒ TemplateInformation

Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::ListTemplatesForDocumentOptions —

    Options for modifying the behavior of the function.

Returns:



5845
5846
5847
5848
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5845

def list_templates_for_document(, document_id, envelope_id, options = DocuSign_eSign::ListTemplatesForDocumentOptions.default)
  data, _status_code, _headers = list_templates_for_document_with_http_info(, document_id, envelope_id, options)
  return data
end

#list_templates_for_document_with_http_info(account_id, document_id, envelope_id, options = DocuSign_eSign::ListTemplatesForDocumentOptions.default) ⇒ Array<(TemplateInformation, Fixnum, Hash)>

Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::ListTemplatesForDocumentOptions —

    Options for modifying the behavior of the function.

Returns:

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

    TemplateInformation data, response status code and response headers



5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5857

def list_templates_for_document_with_http_info(, document_id, envelope_id, options = DocuSign_eSign::ListTemplatesForDocumentOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.list_templates_for_document ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.list_templates_for_document" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.list_templates_for_document" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_templates_for_document" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include'] = options.include if !options.include.nil?

  # 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 => 'TemplateInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#list_templates_for_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_templates_with_http_info(account_id, envelope_id, options = DocuSign_eSign::ListTemplatesOptions.default) ⇒ Array<(TemplateInformation, Fixnum, Hash)>

Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • DocuSign_eSign::ListTemplatesOptions —

    Options for modifying the behavior of the function.

Returns:

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

    TemplateInformation data, response status code and response headers



5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5799

def list_templates_with_http_info(, envelope_id, options = DocuSign_eSign::ListTemplatesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.list_templates ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.list_templates" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.list_templates" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include'] = options.include if !options.include.nil?

  # 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 => 'TemplateInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#list_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_attachment(account_id, attachment_id, envelope_id, attachment) ⇒ EnvelopeAttachmentsResult

Add an attachment to a DRAFT or IN-PROCESS envelope. Adds an attachment to a draft or in-process envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • attachment_id
  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • attachment (optional parameter)

Returns:



5905
5906
5907
5908
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5905

def put_attachment(, attachment_id, envelope_id, attachment)
  data, _status_code, _headers = put_attachment_with_http_info(, attachment_id, envelope_id,  attachment)
  return data
end

#put_attachment_with_http_info(account_id, attachment_id, envelope_id, attachment) ⇒ Array<(EnvelopeAttachmentsResult, Fixnum, Hash)>

Add an attachment to a DRAFT or IN-PROCESS envelope. Adds an attachment to a draft or in-process envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • attachment_id
  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • attachment (optional parameter)

Returns:

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

    EnvelopeAttachmentsResult data, response status code and response headers



5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5917

def put_attachment_with_http_info(, attachment_id, envelope_id, attachment)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.put_attachment ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.put_attachment" if .nil?
  # verify the required parameter 'attachment_id' is set
  fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EnvelopesApi.put_attachment" if attachment_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.put_attachment" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(attachment)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EnvelopeAttachmentsResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#put_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_attachments(account_id, envelope_id, envelope_attachments_request) ⇒ EnvelopeAttachmentsResult

Add one or more attachments to a DRAFT or IN-PROCESS envelope. Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see [Supported File Formats](support.docusign.com/guides/ndse-user-guide-supported-file-formats).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_attachments_request (optional parameter)

Returns:



5963
5964
5965
5966
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5963

def put_attachments(, envelope_id, envelope_attachments_request)
  data, _status_code, _headers = put_attachments_with_http_info(, envelope_id,  envelope_attachments_request)
  return data
end

#put_attachments_with_http_info(account_id, envelope_id, envelope_attachments_request) ⇒ Array<(EnvelopeAttachmentsResult, Fixnum, Hash)>

Add one or more attachments to a DRAFT or IN-PROCESS envelope. Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see [Supported File Formats](support.docusign.com/guides/ndse-user-guide-supported-file-formats).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_attachments_request (optional parameter)

Returns:

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

    EnvelopeAttachmentsResult data, response status code and response headers



5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5974

def put_attachments_with_http_info(, envelope_id, envelope_attachments_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.put_attachments ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.put_attachments" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.put_attachments" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(envelope_attachments_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EnvelopeAttachmentsResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#put_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rotate_document_page(account_id, document_id, envelope_id, page_number, page_request) ⇒ nil

Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • page_number —

    The page number being accessed.

  • page_request (optional parameter)

Returns:

  • (nil) 


6020
6021
6022
6023
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6020

def rotate_document_page(, document_id, envelope_id, page_number, page_request)
  rotate_document_page_with_http_info(, document_id, envelope_id, page_number,  page_request)
  return nil
end

#rotate_document_page_with_http_info(account_id, document_id, envelope_id, page_number, page_request) ⇒ Array<(nil, Fixnum, Hash)>

Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • page_number —

    The page number being accessed.

  • page_request (optional parameter)

Returns:

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

    nil, response status code and response headers



6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6033

def rotate_document_page_with_http_info(, document_id, envelope_id, page_number, page_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.rotate_document_page ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.rotate_document_page" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.rotate_document_page" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.rotate_document_page" if envelope_id.nil?
  # verify the required parameter 'page_number' is set
  fail ArgumentError, "Missing the required parameter 'page_number' when calling EnvelopesApi.rotate_document_page" if page_number.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # 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(page_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, 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: EnvelopesApi#rotate_document_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(account_id, envelope_id, envelope, options = DocuSign_eSign::UpdateOptions.default) ⇒ EnvelopeUpdateSummary

Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add "status":"sent" to the request body to send the envelope. * Voids the specified in-process envelope. Add "voidedReason":"The reason for voiding the envelope" to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add "emailBlurb":"message" to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add type" to the request body. *Additional information on purging documents* The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If ‘purgeState="documents_queued"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= "documents_and_metadata_queued"` is used in the request, then the documents, attachments, and tabs are deleted.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope (optional parameter)
  • DocuSign_eSign::UpdateOptions —

    Options for modifying the behavior of the function.

Returns:



6081
6082
6083
6084
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6081

def update(, envelope_id, envelope, options = DocuSign_eSign::UpdateOptions.default)
  data, _status_code, _headers = update_with_http_info(, envelope_id,  envelope, options)
  return data
end

#update_chunked_upload(account_id, chunked_upload_id, options = DocuSign_eSign::UpdateChunkedUploadOptions.default) ⇒ ChunkedUploadResponse

Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • chunked_upload_id
  • DocuSign_eSign::UpdateChunkedUploadOptions —

    Options for modifying the behavior of the function.

Returns:



6140
6141
6142
6143
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6140

def update_chunked_upload(, chunked_upload_id, options = DocuSign_eSign::UpdateChunkedUploadOptions.default)
  data, _status_code, _headers = update_chunked_upload_with_http_info(, chunked_upload_id, options)
  return data
end

#update_chunked_upload_part(account_id, chunked_upload_id, chunked_upload_part_seq, chunked_upload_request) ⇒ ChunkedUploadResponse

Add a chunk, a chunk ‘part’, to an existing ChunkedUpload. Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the ‘sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: “` PUT /v2.1/accounts/accountId/chunked_uploads/chunkedUploadId/1 PUT /v2.1/accounts/accountId/chunked_uploads/chunkedUploadId/2 PUT /v2.1/accounts/accountId/chunked_uploads/chunkedUploadId/3 “` Note: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • chunked_upload_id
  • chunked_upload_part_seq
  • chunked_upload_request (optional parameter)

Returns:



6197
6198
6199
6200
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6197

def update_chunked_upload_part(, chunked_upload_id, chunked_upload_part_seq, chunked_upload_request)
  data, _status_code, _headers = update_chunked_upload_part_with_http_info(, chunked_upload_id, chunked_upload_part_seq,  chunked_upload_request)
  return data
end

#update_chunked_upload_part_with_http_info(account_id, chunked_upload_id, chunked_upload_part_seq, chunked_upload_request) ⇒ Array<(ChunkedUploadResponse, Fixnum, Hash)>

Add a chunk, a chunk &#39;part&#39;, to an existing ChunkedUpload. Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the &#x60;sequence&#x60; value &#x60;0&#x60;. As a result, DocuSign recommends that you start with a &#x60;sequence&#x60; value of &#x60;1&#x60; when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: &#x60;&#x60;&#x60; PUT /v2.1/accounts/accountId/chunked_uploads/chunkedUploadId/1 PUT /v2.1/accounts/accountId/chunked_uploads/chunkedUploadId/2 PUT /v2.1/accounts/accountId/chunked_uploads/chunkedUploadId/3 &#x60;&#x60;&#x60; Note: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • chunked_upload_id
  • chunked_upload_part_seq
  • chunked_upload_request (optional parameter)

Returns:

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

    ChunkedUploadResponse data, response status code and response headers



6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6209

def update_chunked_upload_part_with_http_info(, chunked_upload_id, chunked_upload_part_seq, chunked_upload_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_chunked_upload_part ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_chunked_upload_part" if .nil?
  # verify the required parameter 'chunked_upload_id' is set
  fail ArgumentError, "Missing the required parameter 'chunked_upload_id' when calling EnvelopesApi.update_chunked_upload_part" if chunked_upload_id.nil?
  # verify the required parameter 'chunked_upload_part_seq' is set
  fail ArgumentError, "Missing the required parameter 'chunked_upload_part_seq' when calling EnvelopesApi.update_chunked_upload_part" if chunked_upload_part_seq.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s).sub('{' + 'chunkedUploadPartSeq' + '}', chunked_upload_part_seq.to_s)

  # 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(chunked_upload_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ChunkedUploadResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_chunked_upload_part\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_chunked_upload_with_http_info(account_id, chunked_upload_id, options = DocuSign_eSign::UpdateChunkedUploadOptions.default) ⇒ Array<(ChunkedUploadResponse, Fixnum, Hash)>

Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • chunked_upload_id
  • DocuSign_eSign::UpdateChunkedUploadOptions —

    Options for modifying the behavior of the function.

Returns:

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

    ChunkedUploadResponse data, response status code and response headers



6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6151

def update_chunked_upload_with_http_info(, chunked_upload_id, options = DocuSign_eSign::UpdateChunkedUploadOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_chunked_upload ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_chunked_upload" if .nil?
  # verify the required parameter 'chunked_upload_id' is set
  fail ArgumentError, "Missing the required parameter 'chunked_upload_id' when calling EnvelopesApi.update_chunked_upload" if chunked_upload_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'action'] = options.action if !options.action.nil?

  # 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(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ChunkedUploadResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_chunked_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_custom_fields(account_id, envelope_id, custom_fields) ⇒ CustomFields

Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • custom_fields (optional parameter)

Returns:



6255
6256
6257
6258
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6255

def update_custom_fields(, envelope_id, custom_fields)
  data, _status_code, _headers = update_custom_fields_with_http_info(, envelope_id,  custom_fields)
  return data
end

#update_custom_fields_with_http_info(account_id, envelope_id, custom_fields) ⇒ Array<(CustomFields, Fixnum, Hash)>

Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • custom_fields (optional parameter)

Returns:

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

    CustomFields data, response status code and response headers



6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6266

def update_custom_fields_with_http_info(, envelope_id, custom_fields)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_custom_fields ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_custom_fields" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_custom_fields" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(custom_fields)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CustomFields')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_document(account_id, document_id, envelope_id, document_file_bytes) ⇒ EnvelopeDocument

Adds a document to an existing draft envelope. Adds a document to an existing draft envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_file_bytes —

    Updated document content.

Returns:



6311
6312
6313
6314
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6311

def update_document(, document_id, envelope_id, document_file_bytes)
  data, _status_code, _headers = update_document_with_http_info(, document_id, envelope_id,  document_file_bytes)
  return data
end

#update_document_fields(account_id, document_id, envelope_id, document_fields_information) ⇒ DocumentFieldsInformation

Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_fields_information (optional parameter)

Returns:



6374
6375
6376
6377
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6374

def update_document_fields(, document_id, envelope_id, document_fields_information)
  data, _status_code, _headers = update_document_fields_with_http_info(, document_id, envelope_id,  document_fields_information)
  return data
end

#update_document_fields_with_http_info(account_id, document_id, envelope_id, document_fields_information) ⇒ Array<(DocumentFieldsInformation, Fixnum, Hash)>

Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_fields_information (optional parameter)

Returns:

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

    DocumentFieldsInformation data, response status code and response headers



6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6386

def update_document_fields_with_http_info(, document_id, envelope_id, document_fields_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document_fields ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_document_fields" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document_fields" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document_fields" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(document_fields_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentFieldsInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_document_tabs(account_id, document_id, envelope_id, tabs) ⇒ Tabs

Updates the tabs for an envelope document Updates tabs in the document specified by ‘documentId` in the envelope specified by `envelopeId`.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • tabs (optional parameter)

Returns:



6433
6434
6435
6436
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6433

def update_document_tabs(, document_id, envelope_id, tabs)
  data, _status_code, _headers = update_document_tabs_with_http_info(, document_id, envelope_id,  tabs)
  return data
end

#update_document_tabs_with_http_info(account_id, document_id, envelope_id, tabs) ⇒ Array<(Tabs, Fixnum, Hash)>

Updates the tabs for an envelope document Updates tabs in the document specified by &#x60;documentId&#x60; in the envelope specified by &#x60;envelopeId&#x60;.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • tabs (optional parameter)

Returns:

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

    Tabs data, response status code and response headers



6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6445

def update_document_tabs_with_http_info(, document_id, envelope_id, tabs)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document_tabs ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_document_tabs" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document_tabs" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document_tabs" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(tabs)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Tabs')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_document_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_document_with_http_info(account_id, document_id, envelope_id, document_file_bytes) ⇒ Array<(EnvelopeDocument, Fixnum, Hash)>

Adds a document to an existing draft envelope. Adds a document to an existing draft envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • document_id —

    The ID of the document being accessed.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_file_bytes —

    Updated document content.

Returns:

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

    EnvelopeDocument data, response status code and response headers



6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6323

def update_document_with_http_info(, document_id, envelope_id, document_file_bytes)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_document" if .nil?
  # verify the required parameter 'document_id' is set
  fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document" if document_id.nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document" if envelope_id.nil?
  # verify the required parameter 'document_file_bytes' is set
  fail ArgumentError, "Missing the required parameter 'document_file_bytes' when calling EnvelopesApi.update_document" if document_file_bytes.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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/pdf'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(document_file_bytes)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EnvelopeDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_documents(account_id, envelope_id, envelope_definition) ⇒ EnvelopeDocumentsResult

Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_definition (optional parameter)

Returns:



6491
6492
6493
6494
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6491

def update_documents(, envelope_id, envelope_definition)
  data, _status_code, _headers = update_documents_with_http_info(, envelope_id,  envelope_definition)
  return data
end

#update_documents_with_http_info(account_id, envelope_id, envelope_definition) ⇒ Array<(EnvelopeDocumentsResult, Fixnum, Hash)>

Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_definition (optional parameter)

Returns:

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

    EnvelopeDocumentsResult data, response status code and response headers



6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6502

def update_documents_with_http_info(, envelope_id, envelope_definition)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_documents ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_documents" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_documents" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(envelope_definition)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EnvelopeDocumentsResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_settings(account_id, envelope_id, email_settings) ⇒ EmailSettings

Updates the email setting overrides for an envelope. Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • email_settings (optional parameter)

Returns:



6546
6547
6548
6549
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6546

def update_email_settings(, envelope_id, email_settings)
  data, _status_code, _headers = update_email_settings_with_http_info(, envelope_id,  email_settings)
  return data
end

#update_email_settings_with_http_info(account_id, envelope_id, email_settings) ⇒ Array<(EmailSettings, Fixnum, Hash)>

Updates the email setting overrides for an envelope. Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • email_settings (optional parameter)

Returns:

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

    EmailSettings data, response status code and response headers



6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6557

def update_email_settings_with_http_info(, envelope_id, email_settings)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_email_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_email_settings" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_email_settings" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(email_settings)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_email_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id, delayed_routing) ⇒ DelayedRouting

Updates the delayed routing rules for an envelope’s workflow step definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step_id
  • delayed_routing (optional parameter)

Returns:



6602
6603
6604
6605
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6602

def update_envelope_delayed_routing_definition(, envelope_id, workflow_step_id, delayed_routing)
  data, _status_code, _headers = update_envelope_delayed_routing_definition_with_http_info(, envelope_id, workflow_step_id,  delayed_routing)
  return data
end

#update_envelope_delayed_routing_definition_with_http_info(account_id, envelope_id, workflow_step_id, delayed_routing) ⇒ Array<(DelayedRouting, Fixnum, Hash)>

Updates the delayed routing rules for an envelope&#39;s workflow step definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step_id
  • delayed_routing (optional parameter)

Returns:

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

    DelayedRouting data, response status code and response headers



6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6614

def update_envelope_delayed_routing_definition_with_http_info(, envelope_id, workflow_step_id, delayed_routing)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_delayed_routing_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_delayed_routing_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_delayed_routing_definition" if envelope_id.nil?
  # verify the required parameter 'workflow_step_id' is set
  fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.update_envelope_delayed_routing_definition" if workflow_step_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)

  # 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(delayed_routing)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DelayedRouting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_envelope_doc_gen_form_fields(account_id, envelope_id, doc_gen_form_field_request, options = DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions.default) ⇒ DocGenFormFieldResponse

Updates formfields for an envelope

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • doc_gen_form_field_request (optional parameter)
  • DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions —

    Options for modifying the behavior of the function.

Returns:



6661
6662
6663
6664
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6661

def update_envelope_doc_gen_form_fields(, envelope_id, doc_gen_form_field_request, options = DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions.default)
  data, _status_code, _headers = update_envelope_doc_gen_form_fields_with_http_info(, envelope_id,  doc_gen_form_field_request, options)
  return data
end

#update_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id, doc_gen_form_field_request, options = DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions.default) ⇒ Array<(DocGenFormFieldResponse, Fixnum, Hash)>

Updates formfields for an envelope

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • doc_gen_form_field_request (optional parameter)
  • DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    DocGenFormFieldResponse data, response status code and response headers



6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6673

def update_envelope_doc_gen_form_fields_with_http_info(, envelope_id, doc_gen_form_field_request, options = DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_doc_gen_form_fields ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_doc_gen_form_fields" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_doc_gen_form_fields" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'update_docgen_formfields_only'] = options.update_docgen_formfields_only if !options.update_docgen_formfields_only.nil?

  # 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(doc_gen_form_field_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocGenFormFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_doc_gen_form_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_envelope_scheduled_sending_definition(account_id, envelope_id, scheduled_sending) ⇒ ScheduledSending

Updates the scheduled sending rules for an envelope’s workflow definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • scheduled_sending (optional parameter)

Returns:



6718
6719
6720
6721
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6718

def update_envelope_scheduled_sending_definition(, envelope_id, scheduled_sending)
  data, _status_code, _headers = update_envelope_scheduled_sending_definition_with_http_info(, envelope_id,  scheduled_sending)
  return data
end

#update_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id, scheduled_sending) ⇒ Array<(ScheduledSending, Fixnum, Hash)>

Updates the scheduled sending rules for an envelope&#39;s workflow definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • scheduled_sending (optional parameter)

Returns:

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

    ScheduledSending data, response status code and response headers



6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6729

def update_envelope_scheduled_sending_definition_with_http_info(, envelope_id, scheduled_sending)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_scheduled_sending_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_scheduled_sending_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_scheduled_sending_definition" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(scheduled_sending)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScheduledSending')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_envelope_transfer_rule(account_id, envelope_transfer_rule_id, envelope_transfer_rule) ⇒ EnvelopeTransferRule

Update an envelope transfer rule for an account. This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the ‘envelopeTransferRuleId` both as a query parameter, and in the request body. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_transfer_rule_id
  • envelope_transfer_rule (optional parameter)

Returns:



6773
6774
6775
6776
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6773

def update_envelope_transfer_rule(, envelope_transfer_rule_id, envelope_transfer_rule)
  data, _status_code, _headers = update_envelope_transfer_rule_with_http_info(, envelope_transfer_rule_id,  envelope_transfer_rule)
  return data
end

#update_envelope_transfer_rule_with_http_info(account_id, envelope_transfer_rule_id, envelope_transfer_rule) ⇒ Array<(EnvelopeTransferRule, Fixnum, Hash)>

Update an envelope transfer rule for an account. This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the &#x60;envelopeTransferRuleId&#x60; both as a query parameter, and in the request body. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_transfer_rule_id
  • envelope_transfer_rule (optional parameter)

Returns:

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

    EnvelopeTransferRule data, response status code and response headers



6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6784

def update_envelope_transfer_rule_with_http_info(, envelope_transfer_rule_id, envelope_transfer_rule)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_transfer_rule ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_transfer_rule" if .nil?
  # verify the required parameter 'envelope_transfer_rule_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_transfer_rule_id' when calling EnvelopesApi.update_envelope_transfer_rule" if envelope_transfer_rule_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeTransferRuleId' + '}', envelope_transfer_rule_id.to_s)

  # 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(envelope_transfer_rule)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EnvelopeTransferRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_transfer_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_envelope_transfer_rules(account_id, envelope_transfer_rule_information) ⇒ EnvelopeTransferRuleInformation

Update envelope transfer rules for an account. This method changes the status for one or more envelope transfer rules based on the ‘envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_transfer_rule_information (optional parameter)

Returns:



6827
6828
6829
6830
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6827

def update_envelope_transfer_rules(, envelope_transfer_rule_information)
  data, _status_code, _headers = update_envelope_transfer_rules_with_http_info(,  envelope_transfer_rule_information)
  return data
end

#update_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_information) ⇒ Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>

Update envelope transfer rules for an account. This method changes the status for one or more envelope transfer rules based on the &#x60;envelopeTransferRuleId&#x60;s in the request body. You use this method to change whether or not the rules are enabled. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_transfer_rule_information (optional parameter)

Returns:



6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6837

def update_envelope_transfer_rules_with_http_info(, envelope_transfer_rule_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_transfer_rules ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_transfer_rules" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # 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(envelope_transfer_rule_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EnvelopeTransferRuleInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_transfer_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_envelope_workflow_definition(account_id, envelope_id, workflow) ⇒ Workflow

Updates the envelope workflow definition for an envelope. Updates the specified envelope’s workflow definition if it has one.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow (optional parameter)

Returns:



6879
6880
6881
6882
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6879

def update_envelope_workflow_definition(, envelope_id, workflow)
  data, _status_code, _headers = update_envelope_workflow_definition_with_http_info(, envelope_id,  workflow)
  return data
end

#update_envelope_workflow_definition_with_http_info(account_id, envelope_id, workflow) ⇒ Array<(Workflow, Fixnum, Hash)>

Updates the envelope workflow definition for an envelope. Updates the specified envelope&#39;s workflow definition if it has one.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow (optional parameter)

Returns:

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

    Workflow data, response status code and response headers



6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6890

def update_envelope_workflow_definition_with_http_info(, envelope_id, workflow)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_workflow_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_workflow_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_workflow_definition" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(workflow)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id, workflow_step) ⇒ WorkflowStep

Updates the envelope workflow step definition for an envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step_id
  • workflow_step (optional parameter)

Returns:



6935
6936
6937
6938
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6935

def update_envelope_workflow_step_definition(, envelope_id, workflow_step_id, workflow_step)
  data, _status_code, _headers = update_envelope_workflow_step_definition_with_http_info(, envelope_id, workflow_step_id,  workflow_step)
  return data
end

#update_envelope_workflow_step_definition_with_http_info(account_id, envelope_id, workflow_step_id, workflow_step) ⇒ Array<(WorkflowStep, Fixnum, Hash)>

Updates the envelope workflow step definition for an envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • workflow_step_id
  • workflow_step (optional parameter)

Returns:

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

    WorkflowStep data, response status code and response headers



6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6947

def update_envelope_workflow_step_definition_with_http_info(, envelope_id, workflow_step_id, workflow_step)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_workflow_step_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_workflow_step_definition" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_workflow_step_definition" if envelope_id.nil?
  # verify the required parameter 'workflow_step_id' is set
  fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.update_envelope_workflow_step_definition" if workflow_step_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)

  # 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(workflow_step)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkflowStep')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_lock(account_id, envelope_id, lock_request) ⇒ LockInformation

Updates an envelope lock. 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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • lock_request (optional parameter)

Returns:



6993
6994
6995
6996
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6993

def update_lock(, envelope_id, lock_request)
  data, _status_code, _headers = update_lock_with_http_info(, envelope_id,  lock_request)
  return data
end

#update_lock_with_http_info(account_id, envelope_id, lock_request) ⇒ Array<(LockInformation, Fixnum, Hash)>

Updates an envelope lock. Updates the lock duration time or update the &#x60;lockedByApp&#x60; property information for the specified envelope. The user and integrator key must match the user specified by the &#x60;lockByUser&#x60; property and integrator key information and the &#x60;X-DocuSign-Edit&#x60; header must be included or an error will be generated.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • lock_request (optional parameter)

Returns:

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

    LockInformation data, response status code and response headers



7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7004

def update_lock_with_http_info(, envelope_id, lock_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_lock ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_lock" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_lock" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(lock_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LockInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_notification_settings(account_id, envelope_id, envelope_notification_request) ⇒ Notification

Sets envelope notification (Reminders/Expirations) structure for an existing envelope. This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_notification_request (optional parameter)

Returns:



7048
7049
7050
7051
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7048

def update_notification_settings(, envelope_id, envelope_notification_request)
  data, _status_code, _headers = update_notification_settings_with_http_info(, envelope_id,  envelope_notification_request)
  return data
end

#update_notification_settings_with_http_info(account_id, envelope_id, envelope_notification_request) ⇒ Array<(Notification, Fixnum, Hash)>

Sets envelope notification (Reminders/Expirations) structure for an existing envelope. This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope_notification_request (optional parameter)

Returns:

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

    Notification data, response status code and response headers



7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7059

def update_notification_settings_with_http_info(, envelope_id, envelope_notification_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_notification_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_notification_settings" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_notification_settings" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(envelope_notification_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Notification')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_notification_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_recipient_document_visibility(account_id, envelope_id, recipient_id, document_visibility_list) ⇒ DocumentVisibilityList

Updates document visibility for the recipients This method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • document_visibility_list (optional parameter)

Returns:



7104
7105
7106
7107
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7104

def update_recipient_document_visibility(, envelope_id, recipient_id, document_visibility_list)
  data, _status_code, _headers = update_recipient_document_visibility_with_http_info(, envelope_id, recipient_id,  document_visibility_list)
  return data
end

#update_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id, document_visibility_list) ⇒ Array<(DocumentVisibilityList, Fixnum, Hash)>

Updates document visibility for the recipients This method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • document_visibility_list (optional parameter)

Returns:

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

    DocumentVisibilityList data, response status code and response headers



7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7116

def update_recipient_document_visibility_with_http_info(, envelope_id, recipient_id, document_visibility_list)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_recipient_document_visibility ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_recipient_document_visibility" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_recipient_document_visibility" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.update_recipient_document_visibility" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # 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(document_visibility_list)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentVisibilityList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_recipient_document_visibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_recipient_initials_image(account_id, envelope_id, recipient_id) ⇒ nil

Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the ‘CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:

  • (nil) 


7162
7163
7164
7165
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7162

def update_recipient_initials_image(, envelope_id, recipient_id)
  update_recipient_initials_image_with_http_info(, envelope_id, recipient_id)
  return nil
end

#update_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id) ⇒ Array<(nil, Fixnum, Hash)>

Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the &#x60;CanSendEnvelope&#x60; property set to true and the &#x60;ExpressSendOnly&#x60; property in &#x60;SendingUser&#x60; structure must be set to false.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:

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

    nil, response status code and response headers



7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7173

def update_recipient_initials_image_with_http_info(, envelope_id, recipient_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_recipient_initials_image ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_recipient_initials_image" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_recipient_initials_image" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.update_recipient_initials_image" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # 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(['image/gif'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, 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: EnvelopesApi#update_recipient_initials_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_recipient_signature_image(account_id, envelope_id, recipient_id) ⇒ nil

Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the ‘CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:

  • (nil) 


7220
7221
7222
7223
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7220

def update_recipient_signature_image(, envelope_id, recipient_id)
  update_recipient_signature_image_with_http_info(, envelope_id, recipient_id)
  return nil
end

#update_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_id) ⇒ Array<(nil, Fixnum, Hash)>

Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the &#x60;CanSendEnvelope&#x60; property set to true and the &#x60;ExpressSendOnly&#x60; property in &#x60;SendingUser&#x60; structure must be set to false.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

Returns:

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

    nil, response status code and response headers



7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7231

def update_recipient_signature_image_with_http_info(, envelope_id, recipient_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_recipient_signature_image ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_recipient_signature_image" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_recipient_signature_image" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.update_recipient_signature_image" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # 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(['image/gif'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, 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: EnvelopesApi#update_recipient_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_recipients(account_id, envelope_id, recipients, options = DocuSign_eSign::UpdateRecipientsOptions.default) ⇒ RecipientsUpdateSummary

Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: ‘email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipients (optional parameter)
  • DocuSign_eSign::UpdateRecipientsOptions —

    Options for modifying the behavior of the function.

Returns:



7279
7280
7281
7282
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7279

def update_recipients(, envelope_id, recipients, options = DocuSign_eSign::UpdateRecipientsOptions.default)
  data, _status_code, _headers = update_recipients_with_http_info(, envelope_id,  recipients, options)
  return data
end

#update_recipients_document_visibility(account_id, envelope_id, document_visibility_list) ⇒ DocumentVisibilityList

Updates document visibility for the recipients This method updates document visibility for one or more recipients based on the ‘recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_visibility_list (optional parameter)

Returns:



7338
7339
7340
7341
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7338

def update_recipients_document_visibility(, envelope_id, document_visibility_list)
  data, _status_code, _headers = update_recipients_document_visibility_with_http_info(, envelope_id,  document_visibility_list)
  return data
end

#update_recipients_document_visibility_with_http_info(account_id, envelope_id, document_visibility_list) ⇒ Array<(DocumentVisibilityList, Fixnum, Hash)>

Updates document visibility for the recipients This method updates document visibility for one or more recipients based on the &#x60;recipientId&#x60; and &#x60;visible&#x60; values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • document_visibility_list (optional parameter)

Returns:

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

    DocumentVisibilityList data, response status code and response headers



7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7349

def update_recipients_document_visibility_with_http_info(, envelope_id, document_visibility_list)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_recipients_document_visibility ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_recipients_document_visibility" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_recipients_document_visibility" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(document_visibility_list)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentVisibilityList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_recipients_document_visibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_recipients_with_http_info(account_id, envelope_id, recipients, options = DocuSign_eSign::UpdateRecipientsOptions.default) ⇒ Array<(RecipientsUpdateSummary, Fixnum, Hash)>

Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: &#x60;email&#x60;, &#x60;userName&#x60;, &#x60;routingOrder&#x60;, &#x60;faxNumber&#x60;, &#x60;deliveryMethod&#x60;, &#x60;accessCode&#x60;, and &#x60;requireIdLookup&#x60;. Once an envelope has been sent, you can only edit: &#x60;email&#x60;, &#x60;userName&#x60;, &#x60;signerName&#x60;, &#x60;routingOrder&#x60;, &#x60;faxNumber&#x60;, and &#x60;deliveryMethod&#x60;. You can also select to resend an envelope by using the &#x60;resend_envelope&#x60; option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipients (optional parameter)
  • DocuSign_eSign::UpdateRecipientsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    RecipientsUpdateSummary data, response status code and response headers



7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7291

def update_recipients_with_http_info(, envelope_id, recipients, options = DocuSign_eSign::UpdateRecipientsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_recipients ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_recipients" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_recipients" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'combine_same_order_recipients'] = options.combine_same_order_recipients if !options.combine_same_order_recipients.nil?
  query_params[:'offline_signing'] = options.offline_signing if !options.offline_signing.nil?
  query_params[:'resend_envelope'] = options.resend_envelope if !options.resend_envelope.nil?

  # 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(recipients)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RecipientsUpdateSummary')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tabs(account_id, envelope_id, recipient_id, tabs) ⇒ Tabs

Updates the tabs for a recipient.

Updates one or more tabs for a recipient in a draft envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • tabs (optional parameter)

Returns:



7394
7395
7396
7397
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7394

def update_tabs(, envelope_id, recipient_id, tabs)
  data, _status_code, _headers = update_tabs_with_http_info(, envelope_id, recipient_id,  tabs)
  return data
end

#update_tabs_blob(account_id, envelope_id) ⇒ nil

Update encrypted tabs for envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

  • (nil) 


7451
7452
7453
7454
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7451

def update_tabs_blob(, envelope_id)
  update_tabs_blob_with_http_info(, envelope_id)
  return nil
end

#update_tabs_blob_with_http_info(account_id, envelope_id) ⇒ Array<(nil, Fixnum, Hash)>

Update encrypted tabs for envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

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

    nil, response status code and response headers



7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7461

def update_tabs_blob_with_http_info(, envelope_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_tabs_blob ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_tabs_blob" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_tabs_blob" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # 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(:PUT, 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: EnvelopesApi#update_tabs_blob\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tabs_with_http_info(account_id, envelope_id, recipient_id, tabs) ⇒ Array<(Tabs, Fixnum, Hash)>

Updates the tabs for a recipient.

Updates one or more tabs for a recipient in a draft envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • recipient_id —

    The ID of the recipient being accessed.

  • tabs (optional parameter)

Returns:

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

    Tabs data, response status code and response headers



7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7406

def update_tabs_with_http_info(, envelope_id, recipient_id, tabs)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_tabs ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_tabs" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_tabs" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.update_tabs" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

  # 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(tabs)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Tabs')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_template_delayed_routing_definition(account_id, template_id, workflow_step_id, delayed_routing) ⇒ DelayedRouting

Updates the delayed routing rules for a template’s workflow step definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step_id
  • delayed_routing (optional parameter)

Returns:



7505
7506
7507
7508
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7505

def update_template_delayed_routing_definition(, template_id, workflow_step_id, delayed_routing)
  data, _status_code, _headers = update_template_delayed_routing_definition_with_http_info(, template_id, workflow_step_id,  delayed_routing)
  return data
end

#update_template_delayed_routing_definition_with_http_info(account_id, template_id, workflow_step_id, delayed_routing) ⇒ Array<(DelayedRouting, Fixnum, Hash)>

Updates the delayed routing rules for a template&#39;s workflow step definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step_id
  • delayed_routing (optional parameter)

Returns:

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

    DelayedRouting data, response status code and response headers



7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7517

def update_template_delayed_routing_definition_with_http_info(, template_id, workflow_step_id, delayed_routing)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_delayed_routing_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_delayed_routing_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_delayed_routing_definition" if template_id.nil?
  # verify the required parameter 'workflow_step_id' is set
  fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.update_template_delayed_routing_definition" if workflow_step_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)

  # 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(delayed_routing)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DelayedRouting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_template_delayed_routing_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_template_recipient_document_visibility(account_id, recipient_id, template_id, template_document_visibility_list) ⇒ TemplateDocumentVisibilityList

Updates document visibility for the recipients This method updates the document visibility for a template recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • recipient_id —

    The ID of the recipient being accessed.

  • template_id —

    The ID of the template being accessed.

  • template_document_visibility_list (optional parameter)

Returns:



7564
7565
7566
7567
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7564

def update_template_recipient_document_visibility(, recipient_id, template_id, template_document_visibility_list)
  data, _status_code, _headers = update_template_recipient_document_visibility_with_http_info(, recipient_id, template_id,  template_document_visibility_list)
  return data
end

#update_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id, template_document_visibility_list) ⇒ Array<(TemplateDocumentVisibilityList, Fixnum, Hash)>

Updates document visibility for the recipients This method updates the document visibility for a template recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • recipient_id —

    The ID of the recipient being accessed.

  • template_id —

    The ID of the template being accessed.

  • template_document_visibility_list (optional parameter)

Returns:



7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7576

def update_template_recipient_document_visibility_with_http_info(, recipient_id, template_id, template_document_visibility_list)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_recipient_document_visibility ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_recipient_document_visibility" if .nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.update_template_recipient_document_visibility" if recipient_id.nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_recipient_document_visibility" if template_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)

  # 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(template_document_visibility_list)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TemplateDocumentVisibilityList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_template_recipient_document_visibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_template_recipients_document_visibility(account_id, template_id, template_document_visibility_list) ⇒ TemplateDocumentVisibilityList

Updates document visibility for the recipients This method updates document visibility for one or more template recipients based on the ‘recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • template_document_visibility_list (optional parameter)

Returns:



7622
7623
7624
7625
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7622

def update_template_recipients_document_visibility(, template_id, template_document_visibility_list)
  data, _status_code, _headers = update_template_recipients_document_visibility_with_http_info(, template_id,  template_document_visibility_list)
  return data
end

#update_template_recipients_document_visibility_with_http_info(account_id, template_id, template_document_visibility_list) ⇒ Array<(TemplateDocumentVisibilityList, Fixnum, Hash)>

Updates document visibility for the recipients This method updates document visibility for one or more template recipients based on the &#x60;recipientId&#x60; and &#x60;visible&#x60; values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • template_document_visibility_list (optional parameter)

Returns:



7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7633

def update_template_recipients_document_visibility_with_http_info(, template_id, template_document_visibility_list)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_recipients_document_visibility ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_recipients_document_visibility" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_recipients_document_visibility" if template_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s)

  # 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(template_document_visibility_list)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TemplateDocumentVisibilityList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_template_recipients_document_visibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_template_scheduled_sending_definition(account_id, template_id, scheduled_sending) ⇒ ScheduledSending

Updates the scheduled sending rules for a template’s workflow definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • scheduled_sending (optional parameter)

Returns:



7677
7678
7679
7680
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7677

def update_template_scheduled_sending_definition(, template_id, scheduled_sending)
  data, _status_code, _headers = update_template_scheduled_sending_definition_with_http_info(, template_id,  scheduled_sending)
  return data
end

#update_template_scheduled_sending_definition_with_http_info(account_id, template_id, scheduled_sending) ⇒ Array<(ScheduledSending, Fixnum, Hash)>

Updates the scheduled sending rules for a template&#39;s workflow definition.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • scheduled_sending (optional parameter)

Returns:

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

    ScheduledSending data, response status code and response headers



7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7688

def update_template_scheduled_sending_definition_with_http_info(, template_id, scheduled_sending)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_scheduled_sending_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_scheduled_sending_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_scheduled_sending_definition" if template_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s)

  # 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(scheduled_sending)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScheduledSending')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_template_scheduled_sending_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_template_workflow_definition(account_id, template_id, workflow) ⇒ Workflow

Updates the workflow definition for a template. Updates the specified template’s workflow definition if it has one.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow (optional parameter)

Returns:



7732
7733
7734
7735
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7732

def update_template_workflow_definition(, template_id, workflow)
  data, _status_code, _headers = update_template_workflow_definition_with_http_info(, template_id,  workflow)
  return data
end

#update_template_workflow_definition_with_http_info(account_id, template_id, workflow) ⇒ Array<(Workflow, Fixnum, Hash)>

Updates the workflow definition for a template. Updates the specified template&#39;s workflow definition if it has one.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow (optional parameter)

Returns:

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

    Workflow data, response status code and response headers



7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7743

def update_template_workflow_definition_with_http_info(, template_id, workflow)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_workflow_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_workflow_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_workflow_definition" if template_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s)

  # 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(workflow)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_template_workflow_step_definition(account_id, template_id, workflow_step_id, workflow_step) ⇒ WorkflowStep

Updates the template workflow step definition for an envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step_id
  • workflow_step (optional parameter)

Returns:



7788
7789
7790
7791
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7788

def update_template_workflow_step_definition(, template_id, workflow_step_id, workflow_step)
  data, _status_code, _headers = update_template_workflow_step_definition_with_http_info(, template_id, workflow_step_id,  workflow_step)
  return data
end

#update_template_workflow_step_definition_with_http_info(account_id, template_id, workflow_step_id, workflow_step) ⇒ Array<(WorkflowStep, Fixnum, Hash)>

Updates the template workflow step definition for an envelope.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • template_id —

    The ID of the template being accessed.

  • workflow_step_id
  • workflow_step (optional parameter)

Returns:

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

    WorkflowStep data, response status code and response headers



7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7800

def update_template_workflow_step_definition_with_http_info(, template_id, workflow_step_id, workflow_step)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_workflow_step_definition ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_workflow_step_definition" if .nil?
  # verify the required parameter 'template_id' is set
  fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_workflow_step_definition" if template_id.nil?
  # verify the required parameter 'workflow_step_id' is set
  fail ArgumentError, "Missing the required parameter 'workflow_step_id' when calling EnvelopesApi.update_template_workflow_step_definition" if workflow_step_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'workflowStepId' + '}', workflow_step_id.to_s)

  # 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(workflow_step)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WorkflowStep')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update_template_workflow_step_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_with_http_info(account_id, envelope_id, envelope, options = DocuSign_eSign::UpdateOptions.default) ⇒ Array<(EnvelopeUpdateSummary, Fixnum, Hash)>

Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add &quot;status&quot;:&quot;sent&quot; to the request body to send the envelope. * Voids the specified in-process envelope. Add &quot;voidedReason&quot;:&quot;The reason for voiding the envelope&quot; to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add &quot;emailBlurb&quot;:&quot;message&quot; to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add type&quot; to the request body. *Additional information on purging documents* The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If &#x60;purgeState&#x3D;&quot;documents_queued&quot;&#x60; is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If &#x60;purgeState&#x3D; &quot;documents_and_metadata_queued&quot;&#x60; is used in the request, then the documents, attachments, and tabs are deleted.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

  • envelope (optional parameter)
  • DocuSign_eSign::UpdateOptions —

    Options for modifying the behavior of the function.

Returns:

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

    EnvelopeUpdateSummary data, response status code and response headers



6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6093

def update_with_http_info(, envelope_id, envelope, options = DocuSign_eSign::UpdateOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EnvelopesApi.update ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update" if envelope_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'advanced_update'] = options.advanced_update if !options.advanced_update.nil?
  query_params[:'recycle_on_void'] = options.recycle_on_void if !options.recycle_on_void.nil?
  query_params[:'resend_envelope'] = options.resend_envelope if !options.resend_envelope.nil?

  # 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(envelope)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EnvelopeUpdateSummary')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnvelopesApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end