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.
-
#create_document_tabs_with_http_info(account_id, document_id, envelope_id, tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Adds the tabs to an envelope document.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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_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.
-
#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.
-
#delete_document_tabs_with_http_info(account_id, document_id, envelope_id, tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Deletes tabs from an envelope document.
-
#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.
-
#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.
-
#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_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_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_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) ⇒ nil
Retrieves an attachment from the envelope.
-
#get_attachment_with_http_info(account_id, attachment_id, envelope_id) ⇒ Array<(nil, 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.
-
#get_attachments_with_http_info(account_id, envelope_id) ⇒ Array<(EnvelopeAttachmentsResult, Fixnum, Hash)>
Returns a list of attachments associated with the 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.
-
#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.
-
#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_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_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_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.
-
#get_recipient_document_visibility_with_http_info(account_id, envelope_id, recipient_id) ⇒ Array<(DocumentVisibilityList, Fixnum, Hash)>
Returns document visibility for the recipients.
-
#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_recipient_document_visibility(account_id, recipient_id, template_id) ⇒ DocumentVisibilityList
Returns document visibility for the recipients.
-
#get_template_recipient_document_visibility_with_http_info(account_id, recipient_id, template_id) ⇒ Array<(DocumentVisibilityList, Fixnum, Hash)>
Returns document visibility for the recipients.
-
#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.
-
#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) ⇒ 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.
-
#update_document_tabs_with_http_info(account_id, document_id, envelope_id, tabs) ⇒ Array<(Tabs, Fixnum, Hash)>
Updates the tabs for an envelope document.
-
#update_document_with_http_info(account_id, document_id, envelope_id) ⇒ 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_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_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.
-
#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.
-
#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.
-
#update_recipients_document_visibility_with_http_info(account_id, envelope_id, document_visibility_list) ⇒ Array<(DocumentVisibilityList, Fixnum, Hash)>
Updates document visibility for the recipients.
-
#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_regen_document(account_id, envelope_id, regen_document_id, document) ⇒ File
Retrieves a PDF document from the envelope with no CoC.
-
#update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document) ⇒ Array<(File, Fixnum, Hash)>
Retrieves a PDF document from the envelope with no CoC.
-
#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_recipient_document_visibility(account_id, recipient_id, template_id, template_document_visibility_list) ⇒ TemplateDocumentVisibilityList
Updates document visibility for the recipients.
-
#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.
-
#update_template_recipients_document_visibility(account_id, template_id, template_document_visibility_list) ⇒ TemplateDocumentVisibilityList
Updates document visibility for the recipients.
-
#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.
-
#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_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.
482 483 484 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 482 def initialize(api_client = EnvelopesApi.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
480 481 482 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 480 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.
493 494 495 496 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 493 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.
552 553 554 555 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 552 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.
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 565 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.
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 505 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.
611 612 613 614 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 611 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.
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 621 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.
662 663 664 665 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 662 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.
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 672 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.
714 715 716 717 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 714 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.
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 725 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.
769 770 771 772 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 769 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.
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 780 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.
825 826 827 828 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 825 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.
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 837 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.
884 885 886 887 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 884 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.
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 896 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
943 944 945 946 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 943 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
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 955 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.
1001 1002 1003 1004 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1001 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.
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1012 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.
1056 1057 1058 1059 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1056 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.
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1067 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.
1111 1112 1113 1114 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1111 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
1169 1170 1171 1172 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1169 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
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1180 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
1224 1225 1226 1227 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1224 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
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1235 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
1279 1280 1281 1282 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1279 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
1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1290 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.
1333 1334 1335 1336 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1333 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.
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1343 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.
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1122 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_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).
1385 1386 1387 1388 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1385 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).
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1396 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.
1441 1442 1443 1444 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1441 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.
1498 1499 1500 1501 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1498 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.
1509 1510 1511 1512 1513 1514 1515 1516 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1509 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.
1555 1556 1557 1558 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1555 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.
1566 1567 1568 1569 1570 1571 1572 1573 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1566 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.
1613 1614 1615 1616 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1613 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.
1625 1626 1627 1628 1629 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1625 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.
1673 1674 1675 1676 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1673 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.
1684 1685 1686 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1684 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.
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1453 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.
1728 1729 1730 1731 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1728 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.
1739 1740 1741 1742 1743 1744 1745 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1739 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.
1783 1784 1785 1786 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1783 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.
1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1794 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.
1839 1840 1841 1842 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1839 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.
1851 1852 1853 1854 1855 1856 1857 1858 1859 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1851 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 |
#delete_attachments(account_id, envelope_id, envelope_attachments_request) ⇒ EnvelopeAttachmentsResult
Delete one or more attachments from a DRAFT envelope.
1897 1898 1899 1900 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1897 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.
1908 1909 1910 1911 1912 1913 1914 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1908 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.
1951 1952 1953 1954 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1951 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.
1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 1961 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.
2005 2006 2007 2008 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2005 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.
2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2016 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.
2061 2062 2063 2064 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2061 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.
2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2073 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.
2120 2121 2122 2123 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2120 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.
2132 2133 2134 2135 2136 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2132 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
2180 2181 2182 2183 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2180 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
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 2229 2230 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2192 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.
2238 2239 2240 2241 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2238 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.
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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2249 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.
2292 2293 2294 2295 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2292 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.
2302 2303 2304 2305 2306 2307 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2302 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
2346 2347 2348 2349 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2346 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
2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2357 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_transfer_rules(account_id, envelope_transfer_rule_id) ⇒ nil
Delete envelope transfer rules for an account.
2399 2400 2401 2402 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2399 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.
2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2409 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.
2451 2452 2453 2454 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2451 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.
2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2461 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_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.
2503 2504 2505 2506 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2503 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.
2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2513 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.
2557 2558 2559 2560 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2557 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.
2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2568 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.
2614 2615 2616 2617 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2614 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.
2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2625 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.
2670 2671 2672 2673 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2670 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.
2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2682 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_workflow_definition(account_id, template_id) ⇒ nil
Delete the workflow definition for a template.
2727 2728 2729 2730 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2727 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.
2737 2738 2739 2740 2741 2742 2743 2744 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2737 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_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.
2781 2782 2783 2784 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2781 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.
2793 2794 2795 2796 2797 2798 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2793 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) ⇒ nil
Retrieves an attachment from the envelope.
2840 2841 2842 2843 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2840 def (account_id, , envelope_id) (account_id, , envelope_id) return nil end |
#get_attachment_with_http_info(account_id, attachment_id, envelope_id) ⇒ Array<(nil, Fixnum, Hash)>
Retrieves an attachment from the envelope.
2851 2852 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2851 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/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_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
2895 2896 2897 2898 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2895 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
2905 2906 2907 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2905 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.
2949 2950 2951 2952 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2949 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.
2960 2961 2962 2963 2964 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 2960 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
3005 3006 3007 3008 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3005 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
3016 3017 3018 3019 3020 3021 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3016 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.
3063 3064 3065 3066 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3063 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.
3126 3127 3128 3129 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3126 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.
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 3169 3170 3171 3172 3173 3174 3175 3176 3177 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3138 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.
3076 3077 3078 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 3117 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3076 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
3186 3187 3188 3189 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3186 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.
3255 3256 3257 3258 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3255 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.
3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3268 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.
3321 3322 3323 3324 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3321 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.
3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3333 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
3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3198 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.
3380 3381 3382 3383 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3380 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.
3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3390 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.
3434 3435 3436 3437 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3434 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_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.
3491 3492 3493 3494 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3491 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.
3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3502 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.
3547 3548 3549 3550 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3547 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.
3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3557 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_transfer_rules(account_id, options = DocuSign_eSign::GetEnvelopeTransferRulesOptions.default) ⇒ EnvelopeTransferRuleInformation
Returns a list of envelope transfer rules in the specified account.
3600 3601 3602 3603 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3600 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.
3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3610 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.
3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3445 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.
3653 3654 3655 3656 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3653 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.
3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3663 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_form_data(account_id, envelope_id) ⇒ EnvelopeFormData
Returns envelope form data for an existing envelope.
3706 3707 3708 3709 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3706 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.
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 3751 3752 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3716 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.
3759 3760 3761 3762 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3759 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.
3769 3770 3771 3772 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3769 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.
3812 3813 3814 3815 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3812 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.
3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3822 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.
3867 3868 3869 3870 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3867 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.
3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3879 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.
3928 3929 3930 3931 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3928 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.
3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3940 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
3993 3994 3995 3996 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 3993 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
4004 4005 4006 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4004 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.
4051 4052 4053 4054 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4051 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.
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 4099 4100 4101 4102 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4063 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.
4110 4111 4112 4113 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4110 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.
4168 4169 4170 4171 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4168 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.
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 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4180 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.
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 4156 4157 4158 4159 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4121 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.
4226 4227 4228 4229 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4226 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.
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 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4236 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_recipient_document_visibility(account_id, recipient_id, template_id) ⇒ DocumentVisibilityList
Returns document visibility for the recipients
4279 4280 4281 4282 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4279 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
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 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4290 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_workflow_definition(account_id, template_id) ⇒ Workflow
Returns the workflow definition for a template.
4335 4336 4337 4338 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4335 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.
4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4345 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 |
#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.
4388 4389 4390 4391 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4388 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.
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 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4398 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.
4441 4442 4443 4444 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4441 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.
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 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4451 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.
4495 4496 4497 4498 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4495 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.
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 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4506 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.
4552 4553 4554 4555 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4552 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.
4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4563 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_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.
4613 4614 4615 4616 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4613 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.
4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4624 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.
4672 4673 4674 4675 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4672 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.
4736 4737 4738 4739 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4736 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.
4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4746 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_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.
4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4683 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.
4819 4820 4821 4822 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4819 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.
4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4831 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.
4879 4880 4881 4882 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4879 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.
4936 4937 4938 4939 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4936 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.
4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4948 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.
4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4890 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.
4996 4997 4998 4999 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 4996 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.
5008 5009 5010 5011 5012 5013 5014 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5008 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.
5054 5055 5056 5057 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5054 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.
5065 5066 5067 5068 5069 5070 5071 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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5065 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.
5111 5112 5113 5114 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5111 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.
5124 5125 5126 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 5124 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.
5172 5173 5174 5175 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5172 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.
5230 5231 5232 5233 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5230 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.
5287 5288 5289 5290 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5287 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.
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 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5299 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.
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 5274 5275 5276 5277 5278 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5241 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.
5345 5346 5347 5348 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5345 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.
5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5356 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) ⇒ EnvelopeDocument
Adds a document to an existing draft envelope. Adds a document to an existing draft envelope.
5400 5401 5402 5403 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5400 def update_document(account_id, document_id, envelope_id) data, _status_code, _headers = update_document_with_http_info(account_id, document_id, envelope_id) 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.
5458 5459 5460 5461 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5458 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.
5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5470 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
5517 5518 5519 5520 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5517 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
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 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5529 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) ⇒ Array<(EnvelopeDocument, Fixnum, Hash)>
Adds a document to an existing draft envelope. Adds a document to an existing draft envelope.
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 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5411 def update_document_with_http_info(account_id, document_id, envelope_id) 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? # 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']) # 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 => '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.
5575 5576 5577 5578 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5575 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.
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 5586 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.
5630 5631 5632 5633 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5630 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.
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 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5641 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_transfer_rule(account_id, envelope_transfer_rule_id, envelope_transfer_rule) ⇒ EnvelopeTransferRule
Update an envelope transfer rule for an account.
5685 5686 5687 5688 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5685 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.
5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5696 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.
5739 5740 5741 5742 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5739 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.
5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5749 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.
5791 5792 5793 5794 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5791 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.
5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5802 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_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.
5846 5847 5848 5849 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5846 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.
5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5857 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.
5901 5902 5903 5904 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5901 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.
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 5941 5942 5943 5944 5945 5946 5947 5948 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5912 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
5957 5958 5959 5960 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5957 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
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 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5969 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.
6015 6016 6017 6018 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6015 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.
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 6058 6059 6060 6061 6062 6063 6064 6065 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6026 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.
6073 6074 6075 6076 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6073 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.
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 6117 6118 6119 6120 6121 6122 6123 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6084 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).
6132 6133 6134 6135 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6132 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
6191 6192 6193 6194 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6191 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
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 6232 6233 6234 6235 6236 6237 6238 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6202 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).
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 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6144 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_regen_document(account_id, envelope_id, regen_document_id, document) ⇒ File
Retrieves a PDF document from the envelope with no CoC.
6247 6248 6249 6250 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6247 def update_regen_document(account_id, envelope_id, regen_document_id, document) data, _status_code, _headers = update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document) return data end |
#update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document) ⇒ Array<(File, Fixnum, Hash)>
Retrieves a PDF document from the envelope with no CoC.
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 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6259 def update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: EnvelopesApi.update_regen_document ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_regen_document" if account_id.nil? # verify the required parameter 'envelope_id' is set fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_regen_document" if envelope_id.nil? # verify the required parameter 'regen_document_id' is set fail ArgumentError, "Missing the required parameter 'regen_document_id' when calling EnvelopesApi.update_regen_document" if regen_document_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{regenDocumentId}/regen".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'regenDocumentId' + '}', regen_document_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/pdf']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(document) 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 => 'File') if @api_client.config.debugging @api_client.config.logger.debug "API called: EnvelopesApi#update_regen_document\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.
6306 6307 6308 6309 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6306 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.
6363 6364 6365 6366 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6363 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.
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 6373 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.
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 6350 6351 6352 6353 6354 6355 6356 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6318 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_recipient_document_visibility(account_id, recipient_id, template_id, template_document_visibility_list) ⇒ TemplateDocumentVisibilityList
Updates document visibility for the recipients
6417 6418 6419 6420 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6417 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
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_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
6475 6476 6477 6478 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6475 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
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_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_workflow_definition(account_id, template_id, workflow) ⇒ Workflow
Updates the workflow definition for a template.
6530 6531 6532 6533 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 6530 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.
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_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_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.
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 5217 5218 5219 5220 5221 5222 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 5184 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 |