Class: DocuSign_eSign::EnvelopesApi
- Inherits:
-
Object
- Object
- DocuSign_eSign::EnvelopesApi
- Defined in:
- lib/docusign_esign/api/envelopes_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#apply_template(account_id, envelope_id, document_template_list, options = DocuSign_eSign::ApplyTemplateOptions.default) ⇒ DocumentTemplateList
Adds templates to an envelope.
-
#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.
-
#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.
-
#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.
-
#create_chunked_upload(account_id, chunked_upload_request) ⇒ ChunkedUploadResponse
Initiate a new ChunkedUpload.
-
#create_chunked_upload_with_http_info(account_id, chunked_upload_request) ⇒ Array<(ChunkedUploadResponse, Fixnum, Hash)>
Initiate a new ChunkedUpload.
-
#create_console_view(account_id, console_view_request) ⇒ ViewUrl
Returns a URL to the authentication view UI.
-
#create_console_view_with_http_info(account_id, console_view_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>
Returns a URL to the authentication view UI.
-
#create_correct_view(account_id, envelope_id, correct_view_request) ⇒ ViewUrl
Returns a URL to the envelope correction UI.
-
#create_correct_view_with_http_info(account_id, envelope_id, correct_view_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>
Returns a URL to the envelope correction UI.
-
#create_custom_fields(account_id, envelope_id, custom_fields) ⇒ CustomFields
Updates envelope custom fields for an envelope.
-
#create_custom_fields_with_http_info(account_id, envelope_id, custom_fields) ⇒ Array<(CustomFields, Fixnum, Hash)>
Updates envelope custom fields for an envelope.
-
#create_document_fields(account_id, document_id, envelope_id, document_fields_information) ⇒ DocumentFieldsInformation
Creates custom document fields in an existing envelope document.
-
#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.
-
#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.
-
#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.
-
#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`.
-
#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 `documentId` in the envelope specified by `envelopeId`.
-
#create_edit_view(account_id, envelope_id, return_url_request) ⇒ ViewUrl
Returns a URL to the edit view UI.
-
#create_edit_view_with_http_info(account_id, envelope_id, return_url_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>
Returns a URL to the edit view UI.
-
#create_email_settings(account_id, envelope_id, email_settings) ⇒ EmailSettings
Adds email setting overrides to an envelope.
-
#create_email_settings_with_http_info(account_id, envelope_id, email_settings) ⇒ Array<(EmailSettings, Fixnum, Hash)>
Adds email setting overrides to an envelope.
-
#create_envelope(account_id, envelope_definition, options = DocuSign_eSign::CreateEnvelopeOptions.default) ⇒ EnvelopeSummary
Creates an envelope.
-
#create_envelope_comments(account_id, envelope_id, comments_publish) ⇒ CommentHistoryResult
Posts a list of comments for authorized user.
-
#create_envelope_comments_with_http_info(account_id, envelope_id, comments_publish) ⇒ Array<(CommentHistoryResult, Fixnum, Hash)>
Posts a list of comments for authorized user.
-
#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.
-
#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.
-
#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.
-
#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.
-
#create_envelope_transfer_rules(account_id, envelope_transfer_rule_request) ⇒ EnvelopeTransferRuleInformation
Add envelope transfer rules to an account.
-
#create_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_request) ⇒ Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>
Add envelope transfer rules to an account.
-
#create_envelope_with_http_info(account_id, envelope_definition, options = DocuSign_eSign::CreateEnvelopeOptions.default) ⇒ Array<(EnvelopeSummary, Fixnum, Hash)>
Creates an envelope.
-
#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.
-
#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's workflow.
-
#create_historical_envelope_publish_transaction(account_id, connect_historical_envelope_republish) ⇒ EnvelopePublishTransaction
Submits a batch of historical envelopes for republish to an adhoc config.
-
#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.
-
#create_lock(account_id, envelope_id, lock_request) ⇒ LockInformation
Lock an envelope.
-
#create_lock_with_http_info(account_id, envelope_id, lock_request) ⇒ Array<(LockInformation, Fixnum, Hash)>
Lock an envelope.
-
#create_recipient(account_id, envelope_id, recipients, options = DocuSign_eSign::CreateRecipientOptions.default) ⇒ Recipients
Adds one or more recipients to an envelope.
-
#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.
-
#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.
-
#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.
-
#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.
-
#create_recipient_proof_file_resource_token(account_id, envelope_id, recipient_id, token_scopes) ⇒ IdEvidenceResourceToken
Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
-
#create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes) ⇒ Array<(IdEvidenceResourceToken, Fixnum, Hash)>
Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
-
#create_recipient_view(account_id, envelope_id, recipient_view_request) ⇒ ViewUrl
Returns a URL to the recipient view UI.
-
#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.
-
#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.
-
#create_responsive_html_preview(account_id, envelope_id, document_html_definition) ⇒ DocumentHtmlDefinitions
Get Responsive HTML Preview for all documents in an envelope.
-
#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.
-
#create_sender_view(account_id, envelope_id, return_url_request) ⇒ ViewUrl
Returns a URL to the sender view UI.
-
#create_sender_view_with_http_info(account_id, envelope_id, return_url_request) ⇒ Array<(ViewUrl, Fixnum, Hash)>
Returns a URL to the sender view UI.
-
#create_tabs(account_id, envelope_id, recipient_id, tabs) ⇒ Tabs
Adds tabs for a recipient.
-
#create_tabs_with_http_info(account_id, envelope_id, recipient_id, tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Adds tabs for a recipient.
-
#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.
-
#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's workflow.
-
#delete_attachments(account_id, envelope_id, envelope_attachments_request) ⇒ EnvelopeAttachmentsResult
Delete one or more attachments from a DRAFT envelope.
-
#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.
-
#delete_chunked_upload(account_id, chunked_upload_id) ⇒ ChunkedUploadResponse
Delete an existing ChunkedUpload.
-
#delete_chunked_upload_with_http_info(account_id, chunked_upload_id) ⇒ Array<(ChunkedUploadResponse, Fixnum, Hash)>
Delete an existing ChunkedUpload.
-
#delete_custom_fields(account_id, envelope_id, custom_fields) ⇒ CustomFields
Deletes envelope custom fields for draft and in-process envelopes.
-
#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.
-
#delete_document_fields(account_id, document_id, envelope_id, document_fields_information) ⇒ DocumentFieldsInformation
Deletes custom document fields from an existing envelope document.
-
#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.
-
#delete_document_page(account_id, document_id, envelope_id, page_number) ⇒ nil
Deletes a page from a document in an envelope.
-
#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.
-
#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`.
-
#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 `documentId` in the envelope specified by `envelopeId`.
-
#delete_documents(account_id, envelope_id, envelope_definition) ⇒ EnvelopeDocumentsResult
Deletes documents from a draft envelope.
-
#delete_documents_with_http_info(account_id, envelope_id, envelope_definition) ⇒ Array<(EnvelopeDocumentsResult, Fixnum, Hash)>
Deletes documents from a draft envelope.
-
#delete_email_settings(account_id, envelope_id) ⇒ EmailSettings
Deletes the email setting overrides for an envelope.
-
#delete_email_settings_with_http_info(account_id, envelope_id) ⇒ Array<(EmailSettings, Fixnum, Hash)>
Deletes the email setting overrides for an envelope.
-
#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.
-
#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.
-
#delete_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id) ⇒ nil
Deletes the delayed routing rules for the specified envelope workflow step.
-
#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.
-
#delete_envelope_scheduled_sending_definition(account_id, envelope_id) ⇒ nil
Deletes the scheduled sending rules for the envelope’s workflow.
-
#delete_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id) ⇒ Array<(nil, Fixnum, Hash)>
Deletes the scheduled sending rules for the envelope's workflow.
-
#delete_envelope_transfer_rules(account_id, envelope_transfer_rule_id) ⇒ nil
Delete envelope transfer rules for an account.
-
#delete_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_id) ⇒ Array<(nil, Fixnum, Hash)>
Delete envelope transfer rules for an account.
-
#delete_envelope_workflow_definition(account_id, envelope_id) ⇒ nil
Delete the workflow definition for an envelope.
-
#delete_envelope_workflow_definition_with_http_info(account_id, envelope_id) ⇒ Array<(nil, Fixnum, Hash)>
Delete the workflow definition for an envelope.
-
#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.
-
#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's workflow by step id.
-
#delete_lock(account_id, envelope_id) ⇒ LockInformation
Deletes an envelope lock.
-
#delete_lock_with_http_info(account_id, envelope_id) ⇒ Array<(LockInformation, Fixnum, Hash)>
Deletes an envelope lock.
-
#delete_recipient(account_id, envelope_id, recipient_id) ⇒ Recipients
Deletes a recipient from an envelope.
-
#delete_recipient_with_http_info(account_id, envelope_id, recipient_id) ⇒ Array<(Recipients, Fixnum, Hash)>
Deletes a recipient from an envelope.
-
#delete_recipients(account_id, envelope_id, recipients) ⇒ Recipients
Deletes recipients from an envelope.
-
#delete_recipients_with_http_info(account_id, envelope_id, recipients) ⇒ Array<(Recipients, Fixnum, Hash)>
Deletes recipients from an envelope.
-
#delete_tabs(account_id, envelope_id, recipient_id, tabs) ⇒ Tabs
Deletes the tabs associated with a recipient.
-
#delete_tabs_with_http_info(account_id, envelope_id, recipient_id, tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Deletes the tabs associated with a recipient.
-
#delete_template_delayed_routing_definition(account_id, template_id, workflow_step_id) ⇒ nil
Deletes the delayed routing rules for the specified template workflow step.
-
#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.
-
#delete_template_scheduled_sending_definition(account_id, template_id) ⇒ nil
Deletes the scheduled sending rules for the template’s workflow.
-
#delete_template_scheduled_sending_definition_with_http_info(account_id, template_id) ⇒ Array<(nil, Fixnum, Hash)>
Deletes the scheduled sending rules for the template's workflow.
-
#delete_template_workflow_definition(account_id, template_id) ⇒ nil
Delete the workflow definition for a template.
-
#delete_template_workflow_definition_with_http_info(account_id, template_id) ⇒ Array<(nil, Fixnum, Hash)>
Delete the workflow definition for a template.
-
#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.
-
#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's workflow by step id.
-
#delete_templates_from_document(account_id, document_id, envelope_id, template_id) ⇒ nil
Deletes a template from a document in an existing envelope.
-
#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.
-
#get_attachment(account_id, attachment_id, envelope_id) ⇒ File
Retrieves an attachment from the envelope.
-
#get_attachment_with_http_info(account_id, attachment_id, envelope_id) ⇒ Array<(File, Fixnum, Hash)>
Retrieves an attachment from the envelope.
-
#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.
-
#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.
-
#get_chunked_upload(account_id, chunked_upload_id, options = DocuSign_eSign::GetChunkedUploadOptions.default) ⇒ ChunkedUploadResponse
Retrieves the current metadata of a ChunkedUpload.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#get_document(account_id, document_id, envelope_id, options = DocuSign_eSign::GetDocumentOptions.default) ⇒ File
Gets a document from an envelope.
-
#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.
-
#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.
-
#get_document_tabs(account_id, document_id, envelope_id, options = DocuSign_eSign::GetDocumentTabsOptions.default) ⇒ Tabs
Returns tabs on the document.
-
#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.
-
#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.
-
#get_email_settings(account_id, envelope_id) ⇒ EmailSettings
Gets the email setting overrides for an envelope.
-
#get_email_settings_with_http_info(account_id, envelope_id) ⇒ Array<(EmailSettings, Fixnum, Hash)>
Gets the email setting overrides for an envelope.
-
#get_envelope(account_id, envelope_id, options = DocuSign_eSign::GetEnvelopeOptions.default) ⇒ Envelope
Gets the status of a envelope.
-
#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.
-
#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's workflow step definition.
-
#get_envelope_doc_gen_form_fields(account_id, envelope_id) ⇒ DocGenFormFieldResponse
Returns formfields for an envelope.
-
#get_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id) ⇒ Array<(DocGenFormFieldResponse, Fixnum, Hash)>
Returns formfields for an envelope.
-
#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.
-
#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.
-
#get_envelope_html_definitions(account_id, envelope_id) ⇒ DocumentHtmlDefinitionOriginals
Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
-
#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.
-
#get_envelope_scheduled_sending_definition(account_id, envelope_id) ⇒ ScheduledSending
Returns the scheduled sending rules for an envelope’s workflow definition.
-
#get_envelope_scheduled_sending_definition_with_http_info(account_id, envelope_id) ⇒ Array<(ScheduledSending, Fixnum, Hash)>
Returns the scheduled sending rules for an envelope's workflow definition.
-
#get_envelope_transfer_rules(account_id, options = DocuSign_eSign::GetEnvelopeTransferRulesOptions.default) ⇒ EnvelopeTransferRuleInformation
Returns a list of envelope transfer rules in the specified account.
-
#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.
-
#get_envelope_with_http_info(account_id, envelope_id, options = DocuSign_eSign::GetEnvelopeOptions.default) ⇒ Array<(Envelope, Fixnum, Hash)>
Gets the status of a envelope.
-
#get_envelope_workflow_definition(account_id, envelope_id) ⇒ Workflow
Returns the workflow definition for an envelope.
-
#get_envelope_workflow_definition_with_http_info(account_id, envelope_id) ⇒ Array<(Workflow, Fixnum, Hash)>
Returns the workflow definition for an envelope.
-
#get_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id) ⇒ WorkflowStep
Returns the workflow step definition for an envelope by step id.
-
#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.
-
#get_form_data(account_id, envelope_id) ⇒ EnvelopeFormData
Returns envelope form data for an existing envelope.
-
#get_form_data_with_http_info(account_id, envelope_id) ⇒ Array<(EnvelopeFormData, Fixnum, Hash)>
Returns envelope form data for an existing envelope.
-
#get_lock(account_id, envelope_id) ⇒ LockInformation
Gets envelope lock information.
-
#get_lock_with_http_info(account_id, envelope_id) ⇒ Array<(LockInformation, Fixnum, Hash)>
Gets envelope lock information.
-
#get_notification_settings(account_id, envelope_id) ⇒ Notification
Gets envelope notification information.
-
#get_notification_settings_with_http_info(account_id, envelope_id) ⇒ Array<(Notification, Fixnum, Hash)>
Gets envelope notification information.
-
#get_page_tabs(account_id, document_id, envelope_id, page_number) ⇒ Tabs
Returns tabs on the specified page.
-
#get_page_tabs_with_http_info(account_id, document_id, envelope_id, page_number) ⇒ Array<(Tabs, Fixnum, Hash)>
Returns tabs on the specified page.
-
#get_pages(account_id, document_id, envelope_id, options = DocuSign_eSign::GetPagesOptions.default) ⇒ PageImages
Returns document page image(s) based on input.
-
#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.
-
#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.
-
#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.
-
#get_recipient_initials_image(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientInitialsImageOptions.default) ⇒ File
Gets the initials image for a user.
-
#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.
-
#get_recipient_signature(account_id, envelope_id, recipient_id) ⇒ UserSignature
Gets signature information for a signer or sign-in-person recipient.
-
#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.
-
#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.
-
#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.
-
#get_tabs_blob(account_id, envelope_id) ⇒ nil
Get encrypted tabs for envelope.
-
#get_tabs_blob_with_http_info(account_id, envelope_id) ⇒ Array<(nil, Fixnum, Hash)>
Get encrypted tabs for envelope.
-
#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.
-
#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's workflow step definition.
-
#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.
-
#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.
-
#get_template_scheduled_sending_definition(account_id, template_id) ⇒ ScheduledSending
Returns the scheduled sending rules for a template’s workflow definition.
-
#get_template_scheduled_sending_definition_with_http_info(account_id, template_id) ⇒ Array<(ScheduledSending, Fixnum, Hash)>
Returns the scheduled sending rules for a template's workflow definition.
-
#get_template_workflow_definition(account_id, template_id) ⇒ Workflow
Returns the workflow definition for a template.
-
#get_template_workflow_definition_with_http_info(account_id, template_id) ⇒ Array<(Workflow, Fixnum, Hash)>
Returns the workflow definition for a template.
-
#get_template_workflow_step_definition(account_id, template_id, workflow_step_id) ⇒ WorkflowStep
Returns the workflow step definition for a template by step id.
-
#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.
-
#initialize(api_client = EnvelopesApi.default) ⇒ EnvelopesApi
constructor
A new instance of EnvelopesApi.
-
#list_audit_events(account_id, envelope_id) ⇒ EnvelopeAuditEventResponse
Gets the envelope audit events for an envelope.
-
#list_audit_events_with_http_info(account_id, envelope_id) ⇒ Array<(EnvelopeAuditEventResponse, Fixnum, Hash)>
Gets the envelope audit events for an envelope.
-
#list_custom_fields(account_id, envelope_id) ⇒ CustomFieldsEnvelope
Gets the custom field information for the specified envelope.
-
#list_custom_fields_with_http_info(account_id, envelope_id) ⇒ Array<(CustomFieldsEnvelope, Fixnum, Hash)>
Gets the custom field information for the specified envelope.
-
#list_document_fields(account_id, document_id, envelope_id) ⇒ DocumentFieldsInformation
Gets the custom document fields from an existing envelope document.
-
#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.
-
#list_documents(account_id, envelope_id, options = DocuSign_eSign::ListDocumentsOptions.default) ⇒ EnvelopeDocumentsResult
Gets a list of envelope documents.
-
#list_documents_with_http_info(account_id, envelope_id, options = DocuSign_eSign::ListDocumentsOptions.default) ⇒ Array<(EnvelopeDocumentsResult, Fixnum, Hash)>
Gets a list of envelope documents.
-
#list_recipients(account_id, envelope_id, options = DocuSign_eSign::ListRecipientsOptions.default) ⇒ Recipients
Gets the status of recipients for an envelope.
-
#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.
-
#list_status(account_id, envelope_ids_request, options = DocuSign_eSign::ListStatusOptions.default) ⇒ EnvelopesInformation
Gets the envelope status for the specified envelopes.
-
#list_status_changes(account_id, options = DocuSign_eSign::ListStatusChangesOptions.default) ⇒ EnvelopesInformation
Gets status changes for one or more envelopes.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#put_attachment(account_id, attachment_id, envelope_id, attachment) ⇒ EnvelopeAttachmentsResult
Add an attachment to a DRAFT or IN-PROCESS envelope.
-
#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.
-
#put_attachments(account_id, envelope_id, envelope_attachments_request) ⇒ EnvelopeAttachmentsResult
Add one or more attachments to a DRAFT or IN-PROCESS envelope.
-
#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.
-
#rotate_document_page(account_id, document_id, envelope_id, page_number, page_request) ⇒ nil
Rotates page image from an envelope for display.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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 'part', to an existing ChunkedUpload.
-
#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.
-
#update_custom_fields(account_id, envelope_id, custom_fields) ⇒ CustomFields
Updates envelope custom fields in an envelope.
-
#update_custom_fields_with_http_info(account_id, envelope_id, custom_fields) ⇒ Array<(CustomFields, Fixnum, Hash)>
Updates envelope custom fields in an envelope.
-
#update_document(account_id, document_id, envelope_id, document_file_bytes) ⇒ EnvelopeDocument
Adds a document to an existing draft envelope.
-
#update_document_fields(account_id, document_id, envelope_id, document_fields_information) ⇒ DocumentFieldsInformation
Updates existing custom document fields in an existing envelope document.
-
#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.
-
#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`.
-
#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 `documentId` in the envelope specified by `envelopeId`.
-
#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.
-
#update_documents(account_id, envelope_id, envelope_definition) ⇒ EnvelopeDocumentsResult
Adds one or more documents to an existing envelope document.
-
#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.
-
#update_email_settings(account_id, envelope_id, email_settings) ⇒ EmailSettings
Updates the email setting overrides for an envelope.
-
#update_email_settings_with_http_info(account_id, envelope_id, email_settings) ⇒ Array<(EmailSettings, Fixnum, Hash)>
Updates the email setting overrides for an envelope.
-
#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.
-
#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's workflow step definition.
-
#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.
-
#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.
-
#update_envelope_scheduled_sending_definition(account_id, envelope_id, scheduled_sending) ⇒ ScheduledSending
Updates the scheduled sending rules for an envelope’s workflow definition.
-
#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's workflow definition.
-
#update_envelope_transfer_rule(account_id, envelope_transfer_rule_id, envelope_transfer_rule) ⇒ EnvelopeTransferRule
Update an envelope transfer rule for an account.
-
#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.
-
#update_envelope_transfer_rules(account_id, envelope_transfer_rule_information) ⇒ EnvelopeTransferRuleInformation
Update envelope transfer rules for an account.
-
#update_envelope_transfer_rules_with_http_info(account_id, envelope_transfer_rule_information) ⇒ Array<(EnvelopeTransferRuleInformation, Fixnum, Hash)>
Update envelope transfer rules for an account.
-
#update_envelope_workflow_definition(account_id, envelope_id, workflow) ⇒ Workflow
Updates the envelope workflow definition for an envelope.
-
#update_envelope_workflow_definition_with_http_info(account_id, envelope_id, workflow) ⇒ Array<(Workflow, Fixnum, Hash)>
Updates the envelope workflow definition for an envelope.
-
#update_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id, workflow_step) ⇒ WorkflowStep
Updates the envelope workflow step definition for an envelope.
-
#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.
-
#update_lock(account_id, envelope_id, lock_request) ⇒ LockInformation
Updates an envelope lock.
-
#update_lock_with_http_info(account_id, envelope_id, lock_request) ⇒ Array<(LockInformation, Fixnum, Hash)>
Updates an envelope lock.
-
#update_notification_settings(account_id, envelope_id, envelope_notification_request) ⇒ Notification
Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
-
#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.
-
#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.
-
#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.
-
#update_recipient_initials_image(account_id, envelope_id, recipient_id) ⇒ nil
Sets the initials image for an accountless signer.
-
#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.
-
#update_recipient_signature_image(account_id, envelope_id, recipient_id) ⇒ nil
Sets the signature image for an accountless signer.
-
#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.
-
#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.
-
#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.
-
#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 `recipientId` and `visible` values that you include in the request body.
-
#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.
-
#update_tabs(account_id, envelope_id, recipient_id, tabs) ⇒ Tabs
Updates the tabs for a recipient.
-
#update_tabs_blob(account_id, envelope_id) ⇒ nil
Update encrypted tabs for envelope.
-
#update_tabs_blob_with_http_info(account_id, envelope_id) ⇒ Array<(nil, Fixnum, Hash)>
Update encrypted tabs for envelope.
-
#update_tabs_with_http_info(account_id, envelope_id, recipient_id, tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Updates the tabs for a recipient.
-
#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.
-
#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's workflow step definition.
-
#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.
-
#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.
-
#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.
-
#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 `recipientId` and `visible` values that you include in the request body.
-
#update_template_scheduled_sending_definition(account_id, template_id, scheduled_sending) ⇒ ScheduledSending
Updates the scheduled sending rules for a template’s workflow definition.
-
#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's workflow definition.
-
#update_template_workflow_definition(account_id, template_id, workflow) ⇒ Workflow
Updates the workflow definition for a template.
-
#update_template_workflow_definition_with_http_info(account_id, template_id, workflow) ⇒ Array<(Workflow, Fixnum, Hash)>
Updates the workflow definition for a template.
-
#update_template_workflow_step_definition(account_id, template_id, workflow_step_id, workflow_step) ⇒ WorkflowStep
Updates the template workflow step definition for an envelope.
-
#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.
-
#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.
Constructor Details
#initialize(api_client = EnvelopesApi.default) ⇒ EnvelopesApi
Returns a new instance of EnvelopesApi.
497 498 499 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 497 def initialize(api_client = EnvelopesApi.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
495 496 497 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 495 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.
508 509 510 511 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 508 def apply_template(account_id, envelope_id, document_template_list, = DocuSign_eSign::ApplyTemplateOptions.default) data, _status_code, _headers = apply_template_with_http_info(account_id, envelope_id, document_template_list, ) 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.
567 568 569 570 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 567 def apply_template_to_document(account_id, document_id, envelope_id, document_template_list, = DocuSign_eSign::ApplyTemplateToDocumentOptions.default) data, _status_code, _headers = apply_template_to_document_with_http_info(account_id, document_id, envelope_id, document_template_list, ) 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.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 580 def apply_template_to_document_with_http_info(account_id, document_id, envelope_id, document_template_list, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'preserve_template_recipient'] = .preserve_template_recipient if !.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.
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 520 def apply_template_with_http_info(account_id, envelope_id, document_template_list, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'preserve_template_recipient'] = .preserve_template_recipient if !.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.
626 627 628 629 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 626 def create_chunked_upload(account_id, chunked_upload_request) data, _status_code, _headers = create_chunked_upload_with_http_info(account_id, 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.
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 636 def create_chunked_upload_with_http_info(account_id, 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 account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/chunked_uploads".sub('{format}','json').sub('{' + 'accountId' + '}', account_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(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.
677 678 679 680 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 677 def create_console_view(account_id, console_view_request) data, _status_code, _headers = create_console_view_with_http_info(account_id, 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.
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 687 def create_console_view_with_http_info(account_id, 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 account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/views/console".sub('{format}','json').sub('{' + 'accountId' + '}', account_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(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, correct_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.
729 730 731 732 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 729 def create_correct_view(account_id, envelope_id, correct_view_request) data, _status_code, _headers = create_correct_view_with_http_info(account_id, envelope_id, correct_view_request) return data end |
#create_correct_view_with_http_info(account_id, envelope_id, correct_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.
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 740 def create_correct_view_with_http_info(account_id, envelope_id, correct_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 account_id.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' + '}', account_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(correct_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.
784 785 786 787 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 784 def create_custom_fields(account_id, envelope_id, custom_fields) data, _status_code, _headers = create_custom_fields_with_http_info(account_id, 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.
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 795 def create_custom_fields_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
840 841 842 843 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 840 def create_document_fields(account_id, document_id, envelope_id, document_fields_information) data, _status_code, _headers = create_document_fields_with_http_info(account_id, 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.
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 852 def create_document_fields_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
899 900 901 902 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 899 def create_document_responsive_html_preview(account_id, document_id, envelope_id, document_html_definition) data, _status_code, _headers = create_document_responsive_html_preview_with_http_info(account_id, 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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 911 def create_document_responsive_html_preview_with_http_info(account_id, 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 account_id.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' + '}', account_id.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 } ] } } “`
958 959 960 961 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 958 def create_document_tabs(account_id, document_id, envelope_id, tabs) data, _status_code, _headers = create_document_tabs_with_http_info(account_id, 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 `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 } ] } } ```
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 970 def create_document_tabs_with_http_info(account_id, 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 account_id.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' + '}', account_id.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, return_url_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.
1016 1017 1018 1019 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1016 def create_edit_view(account_id, envelope_id, return_url_request) data, _status_code, _headers = create_edit_view_with_http_info(account_id, envelope_id, return_url_request) return data end |
#create_edit_view_with_http_info(account_id, envelope_id, return_url_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.
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1027 def create_edit_view_with_http_info(account_id, envelope_id, return_url_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 account_id.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' + '}', account_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(return_url_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.
1071 1072 1073 1074 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1071 def create_email_settings(account_id, envelope_id, email_settings) data, _status_code, _headers = create_email_settings_with_http_info(account_id, 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.
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1082 def create_email_settings_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
1126 1127 1128 1129 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1126 def create_envelope(account_id, envelope_definition, = DocuSign_eSign::CreateEnvelopeOptions.default) data, _status_code, _headers = create_envelope_with_http_info(account_id, envelope_definition, ) return data end |
#create_envelope_comments(account_id, envelope_id, comments_publish) ⇒ CommentHistoryResult
Posts a list of comments for authorized user
1184 1185 1186 1187 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1184 def create_envelope_comments(account_id, envelope_id, comments_publish) data, _status_code, _headers = create_envelope_comments_with_http_info(account_id, 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
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1195 def create_envelope_comments_with_http_info(account_id, 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 account_id.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' + '}', account_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(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).
1239 1240 1241 1242 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1239 def create_envelope_recipient_preview(account_id, envelope_id, recipient_preview_request) data, _status_code, _headers = create_envelope_recipient_preview_with_http_info(account_id, 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' experience. For more information, see [Preview and Send](support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1250 def create_envelope_recipient_preview_with_http_info(account_id, 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 account_id.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' + '}', account_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(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/)
1294 1295 1296 1297 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1294 def create_envelope_recipient_shared_view(account_id, envelope_id, recipient_view_request) data, _status_code, _headers = create_envelope_recipient_shared_view_with_http_info(account_id, 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 `<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/)
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1305 def create_envelope_recipient_shared_view_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
1348 1349 1350 1351 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1348 def create_envelope_transfer_rules(account_id, envelope_transfer_rule_request) data, _status_code, _headers = create_envelope_transfer_rules_with_http_info(account_id, 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: - `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.
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1358 def create_envelope_transfer_rules_with_http_info(account_id, 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 account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_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_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'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.
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1137 def create_envelope_with_http_info(account_id, envelope_definition, = 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 account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'cdse_mode'] = .cdse_mode if !.cdse_mode.nil? query_params[:'change_routing_order'] = .change_routing_order if !.change_routing_order.nil? query_params[:'completed_documents_only'] = .completed_documents_only if !.completed_documents_only.nil? query_params[:'merge_roles_on_draft'] = .merge_roles_on_draft if !.merge_roles_on_draft.nil? query_params[:'tab_label_exact_matches'] = .tab_label_exact_matches if !.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
1400 1401 1402 1403 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1400 def create_envelope_workflow_step_definition(account_id, envelope_id, workflow_step) data, _status_code, _headers = create_envelope_workflow_step_definition_with_http_info(account_id, 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's workflow
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1411 def create_envelope_workflow_step_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
1454 1455 1456 1457 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1454 def create_historical_envelope_publish_transaction(account_id, connect_historical_envelope_republish) data, _status_code, _headers = create_historical_envelope_publish_transaction_with_http_info(account_id, 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.
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1464 def create_historical_envelope_publish_transaction_with_http_info(account_id, 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 account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect/envelopes/publish/historical".sub('{format}','json').sub('{' + 'accountId' + '}', account_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(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).
1506 1507 1508 1509 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1506 def create_lock(account_id, envelope_id, lock_request) data, _status_code, _headers = create_lock_with_http_info(account_id, 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 `canLockEnvelopes` must be set to true for the user).
1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1517 def create_lock_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
1562 1563 1564 1565 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1562 def create_recipient(account_id, envelope_id, recipients, = DocuSign_eSign::CreateRecipientOptions.default) data, _status_code, _headers = create_recipient_with_http_info(account_id, envelope_id, recipients, ) 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.
1619 1620 1621 1622 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1619 def create_recipient_manual_review_view(account_id, envelope_id, recipient_id) data, _status_code, _headers = create_recipient_manual_review_view_with_http_info(account_id, 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.
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1630 def create_recipient_manual_review_view_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
1676 1677 1678 1679 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1676 def create_recipient_proof_file_link(account_id, envelope_id, recipient_id) data, _status_code, _headers = create_recipient_proof_file_link_with_http_info(account_id, 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.
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1687 def create_recipient_proof_file_link_with_http_info(account_id, 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 account_id.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' + '}', account_id.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, token_scopes) ⇒ 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/).
1734 1735 1736 1737 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1734 def create_recipient_proof_file_resource_token(account_id, envelope_id, recipient_id, token_scopes) data, _status_code, _headers = create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes) return data end |
#create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes) ⇒ 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/).
1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1746 def create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes) 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 account_id.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? # verify the required parameter 'token_scopes' is set fail ArgumentError, "Missing the required parameter 'token_scopes' when calling EnvelopesApi.create_recipient_proof_file_resource_token" if token_scopes.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'token_scopes' + '}', token_scopes.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 => '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.
1794 1795 1796 1797 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1794 def create_recipient_view(account_id, envelope_id, recipient_view_request) data, _status_code, _headers = create_recipient_view_with_http_info(account_id, 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 `securityDomain` and `authenticationMethod` properties used to verify the user identity.
1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1805 def create_recipient_view_with_http_info(account_id, 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 account_id.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' + '}', account_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(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'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.
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1574 def create_recipient_with_http_info(account_id, envelope_id, recipients, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'resend_envelope'] = .resend_envelope if !.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.
1849 1850 1851 1852 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1849 def create_responsive_html_preview(account_id, envelope_id, document_html_definition) data, _status_code, _headers = create_responsive_html_preview_with_http_info(account_id, 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 `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1860 def create_responsive_html_preview_with_http_info(account_id, 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 account_id.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' + '}', account_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_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, return_url_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.
1904 1905 1906 1907 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1904 def create_sender_view(account_id, envelope_id, return_url_request) data, _status_code, _headers = create_sender_view_with_http_info(account_id, envelope_id, return_url_request) return data end |
#create_sender_view_with_http_info(account_id, envelope_id, return_url_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.
1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1915 def create_sender_view_with_http_info(account_id, envelope_id, return_url_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 account_id.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' + '}', account_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(return_url_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.
1960 1961 1962 1963 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1960 def create_tabs(account_id, envelope_id, recipient_id, tabs) data, _status_code, _headers = create_tabs_with_http_info(account_id, 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.
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1972 def create_tabs_with_http_info(account_id, 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 account_id.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' + '}', account_id.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
2018 2019 2020 2021 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2018 def create_template_workflow_step_definition(account_id, template_id, workflow_step) data, _status_code, _headers = create_template_workflow_step_definition_with_http_info(account_id, 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's workflow
2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2029 def create_template_workflow_step_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
2073 2074 2075 2076 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2073 def (account_id, envelope_id, ) data, _status_code, _headers = (account_id, envelope_id, ) 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.
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2084 def (account_id, envelope_id, ) 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 account_id.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' + '}', account_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() 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.
2127 2128 2129 2130 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2127 def delete_chunked_upload(account_id, chunked_upload_id) data, _status_code, _headers = delete_chunked_upload_with_http_info(account_id, 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.
2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2137 def delete_chunked_upload_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
2181 2182 2183 2184 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2181 def delete_custom_fields(account_id, envelope_id, custom_fields) data, _status_code, _headers = delete_custom_fields_with_http_info(account_id, 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.
2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2192 def delete_custom_fields_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
2237 2238 2239 2240 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2237 def delete_document_fields(account_id, document_id, envelope_id, document_fields_information) data, _status_code, _headers = delete_document_fields_with_http_info(account_id, 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.
2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2249 def delete_document_fields_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
2296 2297 2298 2299 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2296 def delete_document_page(account_id, document_id, envelope_id, page_number) delete_document_page_with_http_info(account_id, 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.
2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2308 def delete_document_page_with_http_info(account_id, 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 account_id.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' + '}', account_id.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`.
2356 2357 2358 2359 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2356 def delete_document_tabs(account_id, document_id, envelope_id, tabs) data, _status_code, _headers = delete_document_tabs_with_http_info(account_id, 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 `documentId` in the envelope specified by `envelopeId`.
2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2368 def delete_document_tabs_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
2414 2415 2416 2417 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2414 def delete_documents(account_id, envelope_id, envelope_definition) data, _status_code, _headers = delete_documents_with_http_info(account_id, 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.
2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2425 def delete_documents_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
2468 2469 2470 2471 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2468 def delete_email_settings(account_id, envelope_id) data, _status_code, _headers = delete_email_settings_with_http_info(account_id, 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.
2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2478 def delete_email_settings_with_http_info(account_id, 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 account_id.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' + '}', account_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(: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.
2522 2523 2524 2525 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2522 def delete_envelope_correct_view(account_id, envelope_id, correct_view_request) delete_envelope_correct_view_with_http_info(account_id, 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.
2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2533 def delete_envelope_correct_view_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
2576 2577 2578 2579 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2576 def delete_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id) delete_envelope_delayed_routing_definition_with_http_info(account_id, 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.
2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2587 def delete_envelope_delayed_routing_definition_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
2631 2632 2633 2634 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2631 def delete_envelope_scheduled_sending_definition(account_id, envelope_id) delete_envelope_scheduled_sending_definition_with_http_info(account_id, 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's workflow.
2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2641 def delete_envelope_scheduled_sending_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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(: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.
2683 2684 2685 2686 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2683 def delete_envelope_transfer_rules(account_id, envelope_transfer_rule_id) delete_envelope_transfer_rules_with_http_info(account_id, 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.
2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2693 def delete_envelope_transfer_rules_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
2735 2736 2737 2738 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2735 def delete_envelope_workflow_definition(account_id, envelope_id) delete_envelope_workflow_definition_with_http_info(account_id, 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's workflow definition if it has one.
2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2745 def delete_envelope_workflow_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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(: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.
2788 2789 2790 2791 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2788 def delete_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id) delete_envelope_workflow_step_definition_with_http_info(account_id, 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's workflow by step id.
2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2799 def delete_envelope_workflow_step_definition_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
2843 2844 2845 2846 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2843 def delete_lock(account_id, envelope_id) data, _status_code, _headers = delete_lock_with_http_info(account_id, 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 `X-DocuSign-Edit` header must be included in the request.
2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2853 def delete_lock_with_http_info(account_id, 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 account_id.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' + '}', account_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(: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.
2897 2898 2899 2900 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2897 def delete_recipient(account_id, envelope_id, recipient_id) data, _status_code, _headers = delete_recipient_with_http_info(account_id, 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.
2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2908 def delete_recipient_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
2954 2955 2956 2957 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2954 def delete_recipients(account_id, envelope_id, recipients) data, _status_code, _headers = delete_recipients_with_http_info(account_id, 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 `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.
2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2965 def delete_recipients_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
3010 3011 3012 3013 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3010 def delete_tabs(account_id, envelope_id, recipient_id, tabs) data, _status_code, _headers = delete_tabs_with_http_info(account_id, 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.
3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3022 def delete_tabs_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
3068 3069 3070 3071 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3068 def delete_template_delayed_routing_definition(account_id, template_id, workflow_step_id) delete_template_delayed_routing_definition_with_http_info(account_id, 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.
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3079 def delete_template_delayed_routing_definition_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
3123 3124 3125 3126 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3123 def delete_template_scheduled_sending_definition(account_id, template_id) delete_template_scheduled_sending_definition_with_http_info(account_id, 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's workflow.
3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3133 def delete_template_scheduled_sending_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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_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.
3175 3176 3177 3178 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3175 def delete_template_workflow_definition(account_id, template_id) delete_template_workflow_definition_with_http_info(account_id, 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's workflow definition if it has one.
3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3185 def delete_template_workflow_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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_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.
3228 3229 3230 3231 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3228 def delete_template_workflow_step_definition(account_id, template_id, workflow_step_id) delete_template_workflow_step_definition_with_http_info(account_id, 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's workflow by step id.
3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3239 def delete_template_workflow_step_definition_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
3285 3286 3287 3288 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3285 def delete_templates_from_document(account_id, document_id, envelope_id, template_id) delete_templates_from_document_with_http_info(account_id, 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.
3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3297 def delete_templates_from_document_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
3344 3345 3346 3347 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3344 def (account_id, , envelope_id) data, _status_code, _headers = (account_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.
3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3355 def (account_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 account_id.nil? # verify the required parameter 'attachment_id' is set fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EnvelopesApi.get_attachment" if .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' + '}', account_id.to_s).sub('{' + 'attachmentId' + '}', .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
3400 3401 3402 3403 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3400 def (account_id, envelope_id) data, _status_code, _headers = (account_id, 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
3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3410 def (account_id, 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 account_id.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' + '}', account_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 => '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.
3454 3455 3456 3457 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3454 def get_chunked_upload(account_id, chunked_upload_id, = DocuSign_eSign::GetChunkedUploadOptions.default) data, _status_code, _headers = get_chunked_upload_with_http_info(account_id, chunked_upload_id, ) 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.
3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3465 def get_chunked_upload_with_http_info(account_id, chunked_upload_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s) # query parameters query_params = {} query_params[:'include'] = .include if !.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).
3510 3511 3512 3513 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3510 def get_comments_transcript(account_id, envelope_id, = DocuSign_eSign::GetCommentsTranscriptOptions.default) data, _status_code, _headers = get_comments_transcript_with_http_info(account_id, envelope_id, ) 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 `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to true).
3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3521 def get_comments_transcript_with_http_info(account_id, envelope_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'encoding'] = .encoding if !.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.
3568 3569 3570 3571 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3568 def get_consumer_disclosure(account_id, envelope_id, lang_code, recipient_id, = DocuSign_eSign::GetConsumerDisclosureOptions.default) data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, ) 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.
3631 3632 3633 3634 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3631 def get_consumer_disclosure_default(account_id, envelope_id, recipient_id, = DocuSign_eSign::GetConsumerDisclosureDefaultOptions.default) data, _status_code, _headers = get_consumer_disclosure_default_with_http_info(account_id, envelope_id, recipient_id, ) 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.
3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3643 def get_consumer_disclosure_default_with_http_info(account_id, envelope_id, recipient_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s) # query parameters query_params = {} query_params[:'langCode'] = .lang_code if !.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.
3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3581 def get_consumer_disclosure_with_http_info(account_id, envelope_id, lang_code, recipient_id, = 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 account_id.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' + '}', account_id.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'] = .lang_code2 if !.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
3691 3692 3693 3694 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3691 def get_document(account_id, document_id, envelope_id, = DocuSign_eSign::GetDocumentOptions.default) data, _status_code, _headers = get_document_with_http_info(account_id, document_id, envelope_id, ) 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.
3760 3761 3762 3763 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3760 def get_document_page_image(account_id, document_id, envelope_id, page_number, = DocuSign_eSign::GetDocumentPageImageOptions.default) data, _status_code, _headers = get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, ) 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.
3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3773 def get_document_page_image_with_http_info(account_id, document_id, envelope_id, page_number, = 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 account_id.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' + '}', account_id.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'] = .dpi if !.dpi.nil? query_params[:'max_height'] = .max_height if !.max_height.nil? query_params[:'max_width'] = .max_width if !.max_width.nil? query_params[:'show_changes'] = .show_changes if !.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`.
3826 3827 3828 3829 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3826 def get_document_tabs(account_id, document_id, envelope_id, = DocuSign_eSign::GetDocumentTabsOptions.default) data, _status_code, _headers = get_document_tabs_with_http_info(account_id, document_id, envelope_id, ) 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 `documentId` in the envelope specified by `envelopeId`.
3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3838 def get_document_tabs_with_http_info(account_id, document_id, envelope_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'include_metadata'] = . if !..nil? query_params[:'page_numbers'] = .page_numbers if !.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 `documentId` parameter in the endpoint with `combined`. /accounts/accountId/envelopes/envelopeId/documents/combined
3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3703 def get_document_with_http_info(account_id, document_id, envelope_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'certificate'] = .certificate if !.certificate.nil? query_params[:'documents_by_userid'] = .documents_by_userid if !.documents_by_userid.nil? query_params[:'encoding'] = .encoding if !.encoding.nil? query_params[:'encrypt'] = .encrypt if !.encrypt.nil? query_params[:'language'] = .language if !.language.nil? query_params[:'recipient_id'] = .recipient_id if !.recipient_id.nil? query_params[:'shared_user_id'] = .shared_user_id if !.shared_user_id.nil? query_params[:'show_changes'] = .show_changes if !.show_changes.nil? query_params[:'watermark'] = .watermark if !.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.
3885 3886 3887 3888 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3885 def get_email_settings(account_id, envelope_id) data, _status_code, _headers = get_email_settings_with_http_info(account_id, 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.
3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3895 def get_email_settings_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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.
3939 3940 3941 3942 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3939 def get_envelope(account_id, envelope_id, = DocuSign_eSign::GetEnvelopeOptions.default) data, _status_code, _headers = get_envelope_with_http_info(account_id, envelope_id, ) 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.
3996 3997 3998 3999 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3996 def get_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id) data, _status_code, _headers = get_envelope_delayed_routing_definition_with_http_info(account_id, 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's workflow step definition.
4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4007 def get_envelope_delayed_routing_definition_with_http_info(account_id, 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 account_id.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' + '}', account_id.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
4052 4053 4054 4055 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4052 def get_envelope_doc_gen_form_fields(account_id, envelope_id) data, _status_code, _headers = get_envelope_doc_gen_form_fields_with_http_info(account_id, 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
4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4062 def get_envelope_doc_gen_form_fields_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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.
4106 4107 4108 4109 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4106 def get_envelope_document_html_definitions(account_id, document_id, envelope_id) data, _status_code, _headers = get_envelope_document_html_definitions_with_http_info(account_id, 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.
4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4117 def get_envelope_document_html_definitions_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
4162 4163 4164 4165 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4162 def get_envelope_html_definitions(account_id, envelope_id) data, _status_code, _headers = get_envelope_html_definitions_with_http_info(account_id, 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.
4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4172 def get_envelope_html_definitions_with_http_info(account_id, 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 account_id.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' + '}', account_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_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.
4215 4216 4217 4218 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4215 def get_envelope_scheduled_sending_definition(account_id, envelope_id) data, _status_code, _headers = get_envelope_scheduled_sending_definition_with_http_info(account_id, 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's workflow definition.
4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4225 def get_envelope_scheduled_sending_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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.
4268 4269 4270 4271 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4268 def get_envelope_transfer_rules(account_id, = DocuSign_eSign::GetEnvelopeTransferRulesOptions.default) data, _status_code, _headers = get_envelope_transfer_rules_with_http_info(account_id, ) 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.
4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4278 def get_envelope_transfer_rules_with_http_info(account_id, = 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 account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'count'] = .count if !.count.nil? query_params[:'start_position'] = .start_position if !.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.
3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3950 def get_envelope_with_http_info(account_id, envelope_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'advanced_update'] = .advanced_update if !.advanced_update.nil? query_params[:'include'] = .include if !.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 => '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.
4321 4322 4323 4324 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4321 def get_envelope_workflow_definition(account_id, envelope_id) data, _status_code, _headers = get_envelope_workflow_definition_with_http_info(account_id, 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's workflow definition if the envelope specified by `envelopeId` has one.
4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4331 def get_envelope_workflow_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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.
4375 4376 4377 4378 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4375 def get_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id) data, _status_code, _headers = get_envelope_workflow_step_definition_with_http_info(account_id, 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.
4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4386 def get_envelope_workflow_step_definition_with_http_info(account_id, 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 account_id.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' + '}', account_id.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/)
4431 4432 4433 4434 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4431 def get_form_data(account_id, envelope_id) data, _status_code, _headers = get_form_data_with_http_info(account_id, 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 "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/)
4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4441 def get_form_data_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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.
4484 4485 4486 4487 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4484 def get_lock(account_id, envelope_id) data, _status_code, _headers = get_lock_with_http_info(account_id, 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 `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.
4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4494 def get_lock_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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.
4537 4538 4539 4540 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4537 def get_notification_settings(account_id, envelope_id) data, _status_code, _headers = get_notification_settings_with_http_info(account_id, 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.
4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4547 def get_notification_settings_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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`.
4592 4593 4594 4595 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4592 def get_page_tabs(account_id, document_id, envelope_id, page_number) data, _status_code, _headers = get_page_tabs_with_http_info(account_id, 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 `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`.
4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4604 def get_page_tabs_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
4653 4654 4655 4656 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4653 def get_pages(account_id, document_id, envelope_id, = DocuSign_eSign::GetPagesOptions.default) data, _status_code, _headers = get_pages_with_http_info(account_id, document_id, envelope_id, ) 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.
4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4665 def get_pages_with_http_info(account_id, document_id, envelope_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'count'] = .count if !.count.nil? query_params[:'dpi'] = .dpi if !.dpi.nil? query_params[:'max_height'] = .max_height if !.max_height.nil? query_params[:'max_width'] = .max_width if !.max_width.nil? query_params[:'nocache'] = .nocache if !.nocache.nil? query_params[:'show_changes'] = .show_changes if !.show_changes.nil? query_params[:'start_position'] = .start_position if !.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.
4718 4719 4720 4721 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4718 def get_recipient_document_visibility(account_id, envelope_id, recipient_id) data, _status_code, _headers = get_recipient_document_visibility_with_http_info(account_id, 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.
4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4729 def get_recipient_document_visibility_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
4776 4777 4778 4779 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4776 def get_recipient_initials_image(account_id, envelope_id, recipient_id, = DocuSign_eSign::GetRecipientInitialsImageOptions.default) data, _status_code, _headers = get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, ) 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'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.
4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4788 def get_recipient_initials_image_with_http_info(account_id, envelope_id, recipient_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s) # query parameters query_params = {} query_params[:'include_chrome'] = .include_chrome if !.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.
4835 4836 4837 4838 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4835 def get_recipient_signature(account_id, envelope_id, recipient_id) data, _status_code, _headers = get_recipient_signature_with_http_info(account_id, 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.
4893 4894 4895 4896 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4893 def get_recipient_signature_image(account_id, envelope_id, recipient_id, = DocuSign_eSign::GetRecipientSignatureImageOptions.default) data, _status_code, _headers = get_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_id, ) 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'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.
4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4905 def get_recipient_signature_image_with_http_info(account_id, envelope_id, recipient_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s) # query parameters query_params = {} query_params[:'include_chrome'] = .include_chrome if !.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.
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4846 def get_recipient_signature_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
4951 4952 4953 4954 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4951 def get_tabs_blob(account_id, envelope_id) get_tabs_blob_with_http_info(account_id, envelope_id) return nil end |
#get_tabs_blob_with_http_info(account_id, envelope_id) ⇒ Array<(nil, Fixnum, Hash)>
Get encrypted tabs for envelope.
4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4961 def get_tabs_blob_with_http_info(account_id, 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 account_id.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' + '}', account_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) 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.
5004 5005 5006 5007 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5004 def get_template_delayed_routing_definition(account_id, template_id, workflow_step_id) data, _status_code, _headers = get_template_delayed_routing_definition_with_http_info(account_id, 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's workflow step definition.
5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5015 def get_template_delayed_routing_definition_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
5061 5062 5063 5064 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5061 def get_template_recipient_document_visibility(account_id, recipient_id, template_id) data, _status_code, _headers = get_template_recipient_document_visibility_with_http_info(account_id, 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.
5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5072 def get_template_recipient_document_visibility_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
5117 5118 5119 5120 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5117 def get_template_scheduled_sending_definition(account_id, template_id) data, _status_code, _headers = get_template_scheduled_sending_definition_with_http_info(account_id, 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's workflow definition.
5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5127 def get_template_scheduled_sending_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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.
5170 5171 5172 5173 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5170 def get_template_workflow_definition(account_id, template_id) data, _status_code, _headers = get_template_workflow_definition_with_http_info(account_id, 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's workflow definition if the template specified by `templateId` has one.
5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5180 def get_template_workflow_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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.
5224 5225 5226 5227 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5224 def get_template_workflow_step_definition(account_id, template_id, workflow_step_id) data, _status_code, _headers = get_template_workflow_step_definition_with_http_info(account_id, 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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5235 def get_template_workflow_step_definition_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
5280 5281 5282 5283 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5280 def list_audit_events(account_id, envelope_id) data, _status_code, _headers = list_audit_events_with_http_info(account_id, 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.
5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5290 def list_audit_events_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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.
5333 5334 5335 5336 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5333 def list_custom_fields(account_id, envelope_id) data, _status_code, _headers = list_custom_fields_with_http_info(account_id, 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.
5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5343 def list_custom_fields_with_http_info(account_id, 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 account_id.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' + '}', account_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 => '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.
5387 5388 5389 5390 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5387 def list_document_fields(account_id, document_id, envelope_id) data, _status_code, _headers = list_document_fields_with_http_info(account_id, 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.
5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5398 def list_document_fields_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
5444 5445 5446 5447 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5444 def list_documents(account_id, envelope_id, = DocuSign_eSign::ListDocumentsOptions.default) data, _status_code, _headers = list_documents_with_http_info(account_id, envelope_id, ) 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.
5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5455 def list_documents_with_http_info(account_id, envelope_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'documents_by_userid'] = .documents_by_userid if !.documents_by_userid.nil? query_params[:'include_docgen_formfields'] = .include_docgen_formfields if !.include_docgen_formfields.nil? query_params[:'include_document_size'] = .include_document_size if !.include_document_size.nil? query_params[:'include_metadata'] = . if !..nil? query_params[:'include_tabs'] = .include_tabs if !.include_tabs.nil? query_params[:'recipient_id'] = .recipient_id if !.recipient_id.nil? query_params[:'shared_user_id'] = .shared_user_id if !.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.
5506 5507 5508 5509 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5506 def list_recipients(account_id, envelope_id, = DocuSign_eSign::ListRecipientsOptions.default) data, _status_code, _headers = list_recipients_with_http_info(account_id, envelope_id, ) 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 `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.
5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5517 def list_recipients_with_http_info(account_id, envelope_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'include_anchor_tab_locations'] = .include_anchor_tab_locations if !.include_anchor_tab_locations.nil? query_params[:'include_extended'] = .include_extended if !.include_extended.nil? query_params[:'include_metadata'] = . if !..nil? query_params[:'include_tabs'] = .include_tabs if !.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.
5565 5566 5567 5568 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5565 def list_status(account_id, envelope_ids_request, = DocuSign_eSign::ListStatusOptions.default) data, _status_code, _headers = list_status_with_http_info(account_id, envelope_ids_request, ) 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` — 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.
5629 5630 5631 5632 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5629 def list_status_changes(account_id, = DocuSign_eSign::ListStatusChangesOptions.default) data, _status_code, _headers = list_status_changes_with_http_info(account_id, ) 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 `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.
5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5639 def list_status_changes_with_http_info(account_id, = 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 account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'ac_status'] = .ac_status if !.ac_status.nil? query_params[:'block'] = .block if !.block.nil? query_params[:'cdse_mode'] = .cdse_mode if !.cdse_mode.nil? query_params[:'continuation_token'] = .continuation_token if !.continuation_token.nil? query_params[:'count'] = .count if !.count.nil? query_params[:'custom_field'] = .custom_field if !.custom_field.nil? query_params[:'email'] = .email if !.email.nil? query_params[:'envelope_ids'] = .envelope_ids if !.envelope_ids.nil? query_params[:'exclude'] = .exclude if !.exclude.nil? query_params[:'folder_ids'] = .folder_ids if !.folder_ids.nil? query_params[:'folder_types'] = .folder_types if !.folder_types.nil? query_params[:'from_date'] = .from_date if !.from_date.nil? query_params[:'from_to_status'] = .from_to_status if !.from_to_status.nil? query_params[:'include'] = .include if !.include.nil? query_params[:'include_purge_information'] = .include_purge_information if !.include_purge_information.nil? query_params[:'intersecting_folder_ids'] = .intersecting_folder_ids if !.intersecting_folder_ids.nil? query_params[:'last_queried_date'] = .last_queried_date if !.last_queried_date.nil? query_params[:'order'] = .order if !.order.nil? query_params[:'order_by'] = .order_by if !.order_by.nil? query_params[:'powerformids'] = .powerformids if !.powerformids.nil? query_params[:'query_budget'] = .query_budget if !.query_budget.nil? query_params[:'requester_date_format'] = .requester_date_format if !.requester_date_format.nil? query_params[:'search_mode'] = .search_mode if !.search_mode.nil? query_params[:'search_text'] = .search_text if !.search_text.nil? query_params[:'start_position'] = .start_position if !.start_position.nil? query_params[:'status'] = .status if !.status.nil? query_params[:'to_date'] = .to_date if !.to_date.nil? query_params[:'transaction_ids'] = .transaction_ids if !.transaction_ids.nil? query_params[:'user_filter'] = .user_filter if !.user_filter.nil? query_params[:'user_id'] = .user_id if !.user_id.nil? query_params[:'user_name'] = .user_name if !.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.
5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5576 def list_status_with_http_info(account_id, envelope_ids_request, = 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 account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/envelopes/status".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'ac_status'] = .ac_status if !.ac_status.nil? query_params[:'block'] = .block if !.block.nil? query_params[:'count'] = .count if !.count.nil? query_params[:'email'] = .email if !.email.nil? query_params[:'envelope_ids'] = .envelope_ids if !.envelope_ids.nil? query_params[:'from_date'] = .from_date if !.from_date.nil? query_params[:'from_to_status'] = .from_to_status if !.from_to_status.nil? query_params[:'start_position'] = .start_position if !.start_position.nil? query_params[:'status'] = .status if !.status.nil? query_params[:'to_date'] = .to_date if !.to_date.nil? query_params[:'transaction_ids'] = .transaction_ids if !.transaction_ids.nil? query_params[:'user_name'] = .user_name if !.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.
5713 5714 5715 5716 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5713 def list_tabs(account_id, envelope_id, recipient_id, = DocuSign_eSign::ListTabsOptions.default) data, _status_code, _headers = list_tabs_with_http_info(account_id, envelope_id, recipient_id, ) 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.
5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5725 def list_tabs_with_http_info(account_id, envelope_id, recipient_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s) # query parameters query_params = {} query_params[:'include_anchor_tab_locations'] = .include_anchor_tab_locations if !.include_anchor_tab_locations.nil? query_params[:'include_metadata'] = . if !..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.
5773 5774 5775 5776 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5773 def list_templates(account_id, envelope_id, = DocuSign_eSign::ListTemplatesOptions.default) data, _status_code, _headers = list_templates_with_http_info(account_id, envelope_id, ) 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.
5830 5831 5832 5833 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5830 def list_templates_for_document(account_id, document_id, envelope_id, = DocuSign_eSign::ListTemplatesForDocumentOptions.default) data, _status_code, _headers = list_templates_for_document_with_http_info(account_id, document_id, envelope_id, ) 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.
5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5842 def list_templates_for_document_with_http_info(account_id, document_id, envelope_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'include'] = .include if !.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.
5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5784 def list_templates_with_http_info(account_id, envelope_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'include'] = .include if !.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.
5890 5891 5892 5893 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5890 def (account_id, , envelope_id, ) data, _status_code, _headers = (account_id, , envelope_id, ) 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.
5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5902 def (account_id, , envelope_id, ) 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 account_id.nil? # verify the required parameter 'attachment_id' is set fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EnvelopesApi.put_attachment" if .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' + '}', account_id.to_s).sub('{' + 'attachmentId' + '}', .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() 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).
5948 5949 5950 5951 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5948 def (account_id, envelope_id, ) data, _status_code, _headers = (account_id, envelope_id, ) 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).
5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5959 def (account_id, envelope_id, ) 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 account_id.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' + '}', account_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() 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.
6005 6006 6007 6008 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6005 def rotate_document_page(account_id, document_id, envelope_id, page_number, page_request) rotate_document_page_with_http_info(account_id, 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.
6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6018 def rotate_document_page_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
6066 6067 6068 6069 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6066 def update(account_id, envelope_id, envelope, = DocuSign_eSign::UpdateOptions.default) data, _status_code, _headers = update_with_http_info(account_id, envelope_id, envelope, ) 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.
6124 6125 6126 6127 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6124 def update_chunked_upload(account_id, chunked_upload_id, = DocuSign_eSign::UpdateChunkedUploadOptions.default) data, _status_code, _headers = update_chunked_upload_with_http_info(account_id, chunked_upload_id, ) 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.
6181 6182 6183 6184 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6181 def update_chunked_upload_part(account_id, chunked_upload_id, chunked_upload_part_seq, chunked_upload_request) data, _status_code, _headers = update_chunked_upload_part_with_http_info(account_id, 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 '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.
6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6193 def update_chunked_upload_part_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6135 def update_chunked_upload_with_http_info(account_id, chunked_upload_id, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'chunkedUploadId' + '}', chunked_upload_id.to_s) # query parameters query_params = {} query_params[:'action'] = .action if !.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.
6239 6240 6241 6242 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6239 def update_custom_fields(account_id, envelope_id, custom_fields) data, _status_code, _headers = update_custom_fields_with_http_info(account_id, 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.
6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6250 def update_custom_fields_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
6295 6296 6297 6298 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6295 def update_document(account_id, document_id, envelope_id, document_file_bytes) data, _status_code, _headers = update_document_with_http_info(account_id, 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.
6358 6359 6360 6361 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6358 def update_document_fields(account_id, document_id, envelope_id, document_fields_information) data, _status_code, _headers = update_document_fields_with_http_info(account_id, 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.
6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6370 def update_document_fields_with_http_info(account_id, 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 account_id.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' + '}', account_id.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`.
6417 6418 6419 6420 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6417 def update_document_tabs(account_id, document_id, envelope_id, tabs) data, _status_code, _headers = update_document_tabs_with_http_info(account_id, 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 `documentId` in the envelope specified by `envelopeId`.
6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6429 def update_document_tabs_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6307 def update_document_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
6475 6476 6477 6478 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6475 def update_documents(account_id, envelope_id, envelope_definition) data, _status_code, _headers = update_documents_with_http_info(account_id, 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.
6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6486 def update_documents_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
6530 6531 6532 6533 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6530 def update_email_settings(account_id, envelope_id, email_settings) data, _status_code, _headers = update_email_settings_with_http_info(account_id, 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.
6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6541 def update_email_settings_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
6586 6587 6588 6589 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6586 def update_envelope_delayed_routing_definition(account_id, envelope_id, workflow_step_id, delayed_routing) data, _status_code, _headers = update_envelope_delayed_routing_definition_with_http_info(account_id, 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's workflow step definition.
6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6598 def update_envelope_delayed_routing_definition_with_http_info(account_id, 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 account_id.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' + '}', account_id.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
6645 6646 6647 6648 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6645 def update_envelope_doc_gen_form_fields(account_id, envelope_id, doc_gen_form_field_request, = DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions.default) data, _status_code, _headers = update_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id, doc_gen_form_field_request, ) 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
6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6657 def update_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id, doc_gen_form_field_request, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'update_docgen_formfields_only'] = .update_docgen_formfields_only if !.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.
6702 6703 6704 6705 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6702 def update_envelope_scheduled_sending_definition(account_id, envelope_id, scheduled_sending) data, _status_code, _headers = update_envelope_scheduled_sending_definition_with_http_info(account_id, 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's workflow definition.
6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6713 def update_envelope_scheduled_sending_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
6757 6758 6759 6760 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6757 def update_envelope_transfer_rule(account_id, envelope_transfer_rule_id, envelope_transfer_rule) data, _status_code, _headers = update_envelope_transfer_rule_with_http_info(account_id, 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 `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.
6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6768 def update_envelope_transfer_rule_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
6811 6812 6813 6814 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6811 def update_envelope_transfer_rules(account_id, envelope_transfer_rule_information) data, _status_code, _headers = update_envelope_transfer_rules_with_http_info(account_id, 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 `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.
6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6821 def update_envelope_transfer_rules_with_http_info(account_id, 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 account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/envelopes/transfer_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_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_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.
6863 6864 6865 6866 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6863 def update_envelope_workflow_definition(account_id, envelope_id, workflow) data, _status_code, _headers = update_envelope_workflow_definition_with_http_info(account_id, 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's workflow definition if it has one.
6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6874 def update_envelope_workflow_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
6919 6920 6921 6922 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6919 def update_envelope_workflow_step_definition(account_id, envelope_id, workflow_step_id, workflow_step) data, _status_code, _headers = update_envelope_workflow_step_definition_with_http_info(account_id, 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.
6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6931 def update_envelope_workflow_step_definition_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
6977 6978 6979 6980 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6977 def update_lock(account_id, envelope_id, lock_request) data, _status_code, _headers = update_lock_with_http_info(account_id, 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 `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.
6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6988 def update_lock_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
7032 7033 7034 7035 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7032 def update_notification_settings(account_id, envelope_id, envelope_notification_request) data, _status_code, _headers = update_notification_settings_with_http_info(account_id, 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.
7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7043 def update_notification_settings_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
7088 7089 7090 7091 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7088 def update_recipient_document_visibility(account_id, envelope_id, recipient_id, document_visibility_list) data, _status_code, _headers = update_recipient_document_visibility_with_http_info(account_id, 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.
7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7100 def update_recipient_document_visibility_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
7146 7147 7148 7149 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7146 def update_recipient_initials_image(account_id, envelope_id, recipient_id) update_recipient_initials_image_with_http_info(account_id, 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 `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false.
7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7157 def update_recipient_initials_image_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
7204 7205 7206 7207 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7204 def update_recipient_signature_image(account_id, envelope_id, recipient_id) update_recipient_signature_image_with_http_info(account_id, 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 `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false.
7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7215 def update_recipient_signature_image_with_http_info(account_id, 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 account_id.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' + '}', account_id.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).
7263 7264 7265 7266 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7263 def update_recipients(account_id, envelope_id, recipients, = DocuSign_eSign::UpdateRecipientsOptions.default) data, _status_code, _headers = update_recipients_with_http_info(account_id, envelope_id, recipients, ) 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.
7322 7323 7324 7325 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7322 def update_recipients_document_visibility(account_id, envelope_id, document_visibility_list) data, _status_code, _headers = update_recipients_document_visibility_with_http_info(account_id, 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 `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.
7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7333 def update_recipients_document_visibility_with_http_info(account_id, 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 account_id.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' + '}', account_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_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: `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).
7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7275 def update_recipients_with_http_info(account_id, envelope_id, recipients, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'combine_same_order_recipients'] = .combine_same_order_recipients if !.combine_same_order_recipients.nil? query_params[:'offline_signing'] = .offline_signing if !.offline_signing.nil? query_params[:'resend_envelope'] = .resend_envelope if !.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.
7378 7379 7380 7381 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7378 def update_tabs(account_id, envelope_id, recipient_id, tabs) data, _status_code, _headers = update_tabs_with_http_info(account_id, envelope_id, recipient_id, tabs) return data end |
#update_tabs_blob(account_id, envelope_id) ⇒ nil
Update encrypted tabs for envelope.
7435 7436 7437 7438 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7435 def update_tabs_blob(account_id, envelope_id) update_tabs_blob_with_http_info(account_id, envelope_id) return nil end |
#update_tabs_blob_with_http_info(account_id, envelope_id) ⇒ Array<(nil, Fixnum, Hash)>
Update encrypted tabs for envelope.
7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7445 def update_tabs_blob_with_http_info(account_id, 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 account_id.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' + '}', account_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(: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.
7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7390 def update_tabs_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
7489 7490 7491 7492 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7489 def update_template_delayed_routing_definition(account_id, template_id, workflow_step_id, delayed_routing) data, _status_code, _headers = update_template_delayed_routing_definition_with_http_info(account_id, 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's workflow step definition.
7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7501 def update_template_delayed_routing_definition_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
7548 7549 7550 7551 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7548 def update_template_recipient_document_visibility(account_id, recipient_id, template_id, template_document_visibility_list) data, _status_code, _headers = update_template_recipient_document_visibility_with_http_info(account_id, 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.
7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7560 def update_template_recipient_document_visibility_with_http_info(account_id, 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 account_id.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' + '}', account_id.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.
7606 7607 7608 7609 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7606 def update_template_recipients_document_visibility(account_id, template_id, template_document_visibility_list) data, _status_code, _headers = update_template_recipients_document_visibility_with_http_info(account_id, 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 `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.
7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7617 def update_template_recipients_document_visibility_with_http_info(account_id, 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 account_id.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' + '}', account_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_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.
7661 7662 7663 7664 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7661 def update_template_scheduled_sending_definition(account_id, template_id, scheduled_sending) data, _status_code, _headers = update_template_scheduled_sending_definition_with_http_info(account_id, 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's workflow definition.
7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7672 def update_template_scheduled_sending_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
7716 7717 7718 7719 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7716 def update_template_workflow_definition(account_id, template_id, workflow) data, _status_code, _headers = update_template_workflow_definition_with_http_info(account_id, 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's workflow definition if it has one.
7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7727 def update_template_workflow_definition_with_http_info(account_id, 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 account_id.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' + '}', account_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(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.
7772 7773 7774 7775 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7772 def update_template_workflow_step_definition(account_id, template_id, workflow_step_id, workflow_step) data, _status_code, _headers = update_template_workflow_step_definition_with_http_info(account_id, 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.
7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 7784 def update_template_workflow_step_definition_with_http_info(account_id, 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 account_id.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' + '}', account_id.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 "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.
6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6078 def update_with_http_info(account_id, envelope_id, envelope, = 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 account_id.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' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} query_params[:'advanced_update'] = .advanced_update if !.advanced_update.nil? query_params[:'resend_envelope'] = .resend_envelope if !.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 |