def testResendEnvelope(self):
with open(SignTest1File, 'rb') as sign_file:
file_contents = sign_file.read()
# create an envelope to be signed
envelope_definition = docusign.EnvelopeDefinition()
envelope_definition.email_subject = 'Please Sign my Python SDK Envelope'
envelope_definition.email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
doc = docusign.Document()
base64_doc = base64.b64encode(file_contents).decode("utf-8")
doc.document_base64 = base64_doc
doc.name = 'TestFile.pdf'
doc.document_id = '1'
envelope_definition.documents = [doc]
# Add a recipient to sign the document
signer = docusign.Signer()
signer.email = Username
signer.name = 'Pat Developer'
signer.recipient_id = '1'
# this value represents the client's unique identifier for the signer
client_user_id = '2939'
signer.client_user_id = client_user_id
# Create a SignHere tab somewhere on the document for the signer to sign
sign_here = docusign.SignHere()
sign_here.document_id = '1'
sign_here.page_number = '1'
sign_here.recipient_id = '1'
sign_here.x_position = '100'
sign_here.y_position = '100'
sign_here.scale_value = '0.5'
tabs = docusign.Tabs()
tabs.sign_here_tabs = [sign_here]
signer.tabs = tabs
recipients = docusign.Recipients()
recipients.signers = [signer]
envelope_definition.recipients = recipients
# send the envelope (otherwise it will be "created" in the Draft folder)
envelope_definition.status = 'sent'
envelopes_api = EnvelopesApi()
try:
docusign.configuration.api_client = self.api_client
recipients_update_summary = envelopes_api.update_recipients(
self.user_info.accounts[0].account_id,
self.envelope_id,
recipients=recipients,
resend_envelope='true')
assert recipients_update_summary is not None
assert len(recipients_update_summary.recipient_update_results) > 0
assert ("SUCCESS" == recipients_update_summary.
recipient_update_results[0].error_details.error_code)
print("RecipientsUpdateSummary: ", end="")
pprint(recipients_update_summary)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testEmbeddedSigning(self):
with open(SignTest1File, 'rb') as sign_file:
file_contents = sign_file.read()
# create an envelope to be signed
envelope_definition = docusign.EnvelopeDefinition()
envelope_definition.email_subject = 'Please Sign my Python SDK Envelope'
envelope_definition.email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
doc = docusign.Document()
base64_doc = base64.b64encode(file_contents).decode("utf-8")
doc.document_base64 = base64_doc
doc.name = 'TestFile.pdf'
doc.document_id = '1'
envelope_definition.documents = [doc]
# Add a recipient to sign the document
signer = docusign.Signer()
signer.email = Username
signer.name = 'Pat Developer'
signer.recipient_id = '1'
# this value represents the client's unique identifier for the signer
client_user_id = '2939'
signer.client_user_id = client_user_id
# Create a SignHere tab somewhere on the document for the signer to sign
sign_here = docusign.SignHere()
sign_here.document_id = '1'
sign_here.page_number = '1'
sign_here.recipient_id = '1'
sign_here.x_position = '100'
sign_here.y_position = '100'
sign_here.scale_value = '0.5'
tabs = docusign.Tabs()
tabs.sign_here_tabs = [sign_here]
signer.tabs = tabs
recipients = docusign.Recipients()
recipients.signers = [signer]
envelope_definition.recipients = recipients
envelope_definition.status = 'sent'
envelopes_api = EnvelopesApi()
try:
return_url = 'http://www.docusign.com/developer-center'
recipient_view_request = docusign.RecipientViewRequest()
recipient_view_request.return_url = return_url
recipient_view_request.client_user_id = client_user_id
recipient_view_request.authentication_method = 'email'
recipient_view_request.user_name = 'Pat Developer'
recipient_view_request.email = Username
envelope_summary = envelopes_api.create_envelope(
self.user_info.accounts[0].account_id,
envelope_definition=envelope_definition)
envelope_id = envelope_summary.envelope_id
view_url = envelopes_api.create_recipient_view(
self.user_info.accounts[0].account_id,
envelope_id,
recipient_view_request=recipient_view_request)
assert view_url is not None
assert view_url.url is not None
# This Url should work in an Iframe or browser to allow signing
print("ViewUrl is ", end="")
pprint(view_url)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testDownLoadEnvelopeDocuments(self):
with open(SignTest1File, 'rb') as sign_file:
file_contents = sign_file.read()
# create an envelope to be signed
envelope_definition = docusign.EnvelopeDefinition()
envelope_definition.email_subject = 'Please Sign my Python SDK Envelope'
envelope_definition.email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
doc = docusign.Document()
base64_doc = base64.b64encode(file_contents).decode("utf-8")
doc.document_base64 = base64_doc
doc.name = 'TestFile.pdf'
doc.document_id = '1'
envelope_definition.documents = [doc]
# Add a recipient to sign the document
signer = docusign.Signer()
signer.email = Username
signer.name = 'Pat Developer'
signer.recipient_id = '1'
# this value represents the client's unique identifier for the signer
client_user_id = '2939'
signer.client_user_id = client_user_id
# Create a Text tab somewhere on the document for the signer to sign
text = docusign.Text()
text.document_id = '1'
text.page_number = '1'
text.recipient_id = '1'
text.x_position = '100'
text.y_position = '100'
text.scale_value = '0.5'
tabs = docusign.Tabs()
tabs.text_tabs = [text]
signer.tabs = tabs
recipients = docusign.Recipients()
recipients.signers = [signer]
envelope_definition.recipients = recipients
# send the envelope (otherwise it will be "created" in the Draft folder)
envelope_definition.status = 'sent'
envelopes_api = EnvelopesApi()
try:
docusign.configuration.api_client = self.api_client
file1 = envelopes_api.get_document(
self.user_info.accounts[0].account_id, 'combined',
self.envelope_id)
assert len(file1) > 0
subprocess.call('open ' + file1, shell=True)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testCreateTemplate(self):
file_contents = open(sign_test1_file, 'rb').read()
# create an envelope to be signed
envelope_template = docusign.EnvelopeTemplate()
envelope_template.email_subject = 'Please Sign my Python SDK Envelope (Embedded Signer)'
envelope_template.email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the template
doc = docusign.Document()
base64_doc = base64.b64encode(file_contents).decode("utf-8")
doc.document_base64 = base64_doc
doc.name = 'TestFile.pdf'
doc.document_id = '1'
envelope_template.documents = [doc]
# Add a recipient to sign the document
signer = docusign.Signer()
signer.email = username
signer.name = 'Pat Developer'
signer.recipient_id = '1'
# Create a SignHere tab somewhere on the document for the signer to sign
sign_here = docusign.SignHere()
sign_here.document_id = '1'
sign_here.page_number = '1'
sign_here.recipient_id = '1'
sign_here.x_position = '100'
sign_here.y_position = '100'
sign_here.scale_value = '0.5'
tabs = docusign.Tabs()
tabs.sign_here_tabs = [sign_here]
signer.tabs = tabs
recipients = docusign.Recipients()
recipients.signers = [signer]
envelope_template.recipients = recipients
env_template_definition = docusign.EnvelopeTemplateDefinition()
env_template_definition.name = 'myTemplate'
envelope_template.envelope_template_definition = env_template_definition
auth_api = AuthenticationApi()
templates_api = TemplatesApi()
try:
login_info = auth_api.login()
assert login_info is not None
assert len(login_info.login_accounts) > 0
login_accounts = login_info.login_accounts
assert login_accounts[0].account_id is not None
base_url, _ = login_accounts[0].base_url.split('/v2')
self.api_client.host = base_url
docusign.configuration.api_client = self.api_client
template_summary = templates_api.create_template(
login_accounts[0].account_id,
envelope_template=envelope_template)
assert template_summary is not None
assert template_summary.template_id is not None
print("TemplateSummary: ", end="")
pprint(template_summary)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testGetDiagnosticLogs(self):
file_contents = open(sign_test1_file, 'rb').read()
# create an envelope to be signed
envelope_definition = docusign.EnvelopeDefinition()
envelope_definition.email_subject = 'Please Sign my Python SDK Envelope'
envelope_definition.email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
doc = docusign.Document()
base64_doc = base64.b64encode(file_contents).decode("utf-8")
doc.document_base64 = base64_doc
doc.name = 'TestFile.pdf'
doc.document_id = '1'
envelope_definition.documents = [doc]
# Add a recipient to sign the document
signer = docusign.Signer()
signer.email = username
signer.name = 'Pat Developer'
signer.recipient_id = '1'
# this value represents the client's unique identifier for the signer
client_user_id = '2939'
signer.client_user_id = client_user_id
# Create a SignHere tab somewhere on the document for the signer to sign
sign_here = docusign.SignHere()
sign_here.document_id = '1'
sign_here.page_number = '1'
sign_here.recipient_id = '1'
sign_here.x_position = '100'
sign_here.y_position = '100'
sign_here.scale_value = '0.5'
tabs = docusign.Tabs()
tabs.sign_here_tabs = [sign_here]
signer.tabs = tabs
recipients = docusign.Recipients()
recipients.signers = [signer]
envelope_definition.recipients = recipients
# send the envelope (otherwise it will be "created" in the Draft folder)
envelope_definition.status = 'sent'
auth_api = AuthenticationApi()
envelopes_api = EnvelopesApi()
diag_api = DiagnosticsApi()
try:
login_info = auth_api.login()
assert login_info is not None
assert len(login_info.login_accounts) > 0
login_accounts = login_info.login_accounts
assert login_accounts[0].account_id is not None
base_url, _ = login_accounts[0].base_url.split('/v2')
self.api_client.host = base_url
docusign.configuration.api_client = self.api_client
diagnostics_settings_information = docusign.DiagnosticsSettingsInformation(
)
diagnostics_settings_information.api_request_logging = 'true'
diag_api.update_request_log_settings(
diagnostics_settings_information=
diagnostics_settings_information)
envelope_summary = envelopes_api.create_envelope(
login_accounts[0].account_id,
envelope_definition=envelope_definition)
assert envelope_summary is not None
assert envelope_summary.envelope_id is not None
print("EnvelopeSummary: ", end="")
pprint(envelope_summary)
file1 = envelopes_api.get_document(login_accounts[0].account_id,
'combined',
envelope_summary.envelope_id)
assert len(file1) > 0
subprocess.call('open ' + file1, shell=True)
logsList = diag_api.list_request_logs()
request_log_id = logsList.api_request_logs[0].request_log_id
file2 = diag_api.get_request_log(request_log_id)
assert len(file2) > 0
subprocess.call('open ' + file2, shell=True)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testGetDiagnosticLogs(self):
with open(SignTest1File, 'rb') as sign_file:
file_contents = sign_file.read()
# Set properties for envelope and create an envelope to be signed later on
email_subject = 'Please Sign my Python SDK Envelope'
email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
base64_doc = base64.b64encode(file_contents).decode("utf-8")
name = 'TestFile.pdf'
document_id = '1'
doc = docusign.Document(document_base64=base64_doc,
name=name,
document_id=document_id)
documents = [doc]
# Create a SignHere tab somewhere on the document for the signer to sign
document_id = '1'
page_number = '1'
recipient_id = '1'
x_position = '100'
y_position = '100'
scale_value = '0.5'
sign_here = docusign.SignHere(document_id=document_id,
page_number=page_number,
recipient_id=recipient_id,
x_position=x_position,
y_position=y_position,
scale_value=scale_value)
sign_here_tabs = [sign_here]
tabs = docusign.Tabs(sign_here_tabs=sign_here_tabs)
# Add a recipient to sign the document
signer_email = Username
signer_name = 'Pat Developer'
signer_recipient_id = '1'
# this value represents the client's unique identifier for the signer
signer_client_user_id = '2939'
signer_tabs = tabs
signer = docusign.Signer(email=signer_email,
name=signer_name,
recipient_id=signer_recipient_id,
client_user_id=signer_client_user_id,
tabs=signer_tabs)
signers = [signer]
recipients = docusign.Recipients(signers=signers)
# send the envelope (otherwise it will be "created" in the Draft folder)
status = 'sent'
# create an envelope to be signed
envelope_definition = docusign.EnvelopeDefinition(
email_subject=email_subject,
email_blurb=email_blurb,
documents=documents,
recipients=recipients,
status=status)
envelopes_api = EnvelopesApi()
diag_api = DiagnosticsApi()
try:
docusign.configuration.api_client = self.api_client
diagnostics_settings_information = docusign.DiagnosticsSettingsInformation(
)
diagnostics_settings_information.api_request_logging = 'true'
diag_api.update_request_log_settings(
diagnostics_settings_information=
diagnostics_settings_information)
envelope_summary = envelopes_api.create_envelope(
self.user_info.accounts[0].account_id,
envelope_definition=envelope_definition)
envelope_id = envelope_summary.envelope_id
file1 = envelopes_api.get_document(
self.user_info.accounts[0].account_id, 'combined', envelope_id)
assert len(file1) > 0
subprocess.call('open ' + file1, shell=True)
logs_list = diag_api.list_request_logs()
request_log_id = logs_list.api_request_logs[0].request_log_id
file2 = diag_api.get_request_log(request_log_id)
assert len(file2) > 0
subprocess.call('open ' + file2, shell=True)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testMoveEnvelopes(self):
with open(SignTest1File, 'rb') as sign_file:
file_contents = sign_file.read()
# Set properties for envelope and create an envelope to be signed later on
email_subject = 'Please Sign my Python SDK Envelope'
email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
base64_doc = base64.b64encode(file_contents).decode("utf-8")
name = 'TestFile.pdf'
document_id = '1'
doc = docusign.Document(document_base64=base64_doc,
name=name,
document_id=document_id)
documents = [doc]
# Add a recipient to sign the document
email = Username
name = 'Pat Developer'
recipient_id = '1'
signer = docusign.Signer(email=email,
name=name,
recipient_id=recipient_id)
# Create a SignHere tab somewhere on the document for the signer to sign
document_id = '1'
page_number = '1'
recipient_id = '1'
x_position = '100'
y_position = '100'
scale_value = '0.5'
sign_here = docusign.SignHere(document_id=document_id,
page_number=page_number,
recipient_id=recipient_id,
x_position=x_position,
y_position=y_position,
scale_value=scale_value)
sign_here_tabs = [sign_here]
tabs = docusign.Tabs(sign_here_tabs=sign_here_tabs)
signer.tabs = tabs
signers = [signer]
recipients = docusign.Recipients(signers=signers)
status = 'sent'
# Now setting all the properties in previous steps create the envelope now
envelope_definition = docusign.EnvelopeDefinition(
email_subject=email_subject,
email_blurb=email_blurb,
documents=documents,
recipients=recipients,
status=status)
envelopes_api = EnvelopesApi()
try:
envelope_summary = envelopes_api.create_envelope(
self.user_info.accounts[0].account_id,
envelope_definition=envelope_definition)
assert envelope_summary is not None
assert envelope_summary.envelope_id is not None
assert envelope_summary.status == 'sent'
folders_api = FoldersApi()
folders_request = docusign.FoldersRequest(
envelope_ids=[envelope_summary.envelope_id],
from_folder_id="sentitems")
to_folder_id = "draft"
folders_api.move_envelopes(self.user_info.accounts[0].account_id,
to_folder_id,
folders_request=folders_request)
# Wait for 3 second to make sure the newly created envelope was moved to the 'sentitems' folder
# Note: It's discouraged to use sleep statement or to poll DocuSign for envelope status or folder id
# In production, use DocuSign Connect to get notified when the status of the envelope have changed.
# 3 Seconds because sometimes when not in public or slow networks, the call takes more time and fails for 1 second.
sleep(3)
# Test if we moved the envelope to the correct folder
search_options = "true"
list_from_drafts_folder = folders_api.list_items(
self.user_info.accounts[0].account_id,
to_folder_id,
include_items=search_options)
assert list_from_drafts_folder is not None
for folder in list_from_drafts_folder.folders:
for list_item in folder.folder_items:
if list_item.envelope_id == envelope_summary.envelope_id:
return
assert False
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testDownLoadEnvelopeDocuments(self):
with open(SignTest1File, 'rb') as sign_file:
file_contents = sign_file.read()
# Set properties and create an envelope to be signed
email_subject = 'Please Sign my Python SDK Envelope'
email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
base64_doc = base64.b64encode(file_contents).decode("utf-8")
document_name = 'TestFile.pdf'
document_id = '1'
doc = docusign.Document(document_base64=base64_doc,
name=document_name,
document_id=document_id)
documents = [doc]
# this value represents the client's unique identifier for the signer
client_user_id = '2939'
# Create a Text tab somewhere on the document for the signer to sign
text_document_id = '1'
page_number = '1'
recipient_id = '1'
x_position = '100'
y_position = '100'
text = docusign.Text(document_id=text_document_id,
page_number=page_number,
recipient_id=recipient_id,
x_position=x_position,
y_position=y_position)
text_tabs = [text]
tabs = docusign.Tabs(text_tabs=text_tabs)
# Add a recipient to sign the document
email = Username
name = 'Pat Developer'
recipient_id = '1'
signer = docusign.Signer(email=email,
name=name,
recipient_id=recipient_id,
client_user_id=client_user_id,
tabs=tabs)
signers = [signer]
recipients = docusign.Recipients(signers=signers)
# send the envelope (otherwise it will be "created" in the Draft folder)
status = 'sent'
# create an envelope to be signed
envelope_definition = docusign.EnvelopeDefinition(
email_subject=email_subject,
email_blurb=email_blurb,
documents=documents,
recipients=recipients,
status=status)
envelopes_api = EnvelopesApi()
try:
docusign.configuration.api_client = self.api_client
file1 = envelopes_api.get_document(
self.user_info.accounts[0].account_id, 'combined',
self.envelope_id)
assert len(file1) > 0
subprocess.call('open ' + file1, shell=True)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testResendEnvelope(self):
with open(SignTest1File, 'rb') as sign_file:
file_contents = sign_file.read()
# Set properties and create an envelope to be signed later on
email_subject = 'Please Sign my Python SDK Envelope'
email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
base64_doc = base64.b64encode(file_contents).decode("utf-8")
name = 'TestFile.pdf'
document_id = '1'
doc = docusign.Document(document_base64=base64_doc,
name=name,
document_id=document_id)
documents = [doc]
# this value represents the client's unique identifier for the signer
client_user_id = '2939'
# Create a SignHere tab somewhere on the document for the signer to sign
document_id = '1'
page_number = '1'
recipient_id = '1'
x_position = '100'
y_position = '100'
scale_value = '0.5'
sign_here = docusign.SignHere(document_id=document_id,
page_number=page_number,
recipient_id=recipient_id,
x_position=x_position,
y_position=y_position,
scale_value=scale_value)
sign_here_tabs = [sign_here]
tabs = docusign.Tabs(sign_here_tabs=sign_here_tabs)
# Add a recipient to sign the document
email = Username
name = 'Pat Developer'
signer_recipient_id = '1'
# Create the signer with the information created previous
signer = docusign.Signer(tabs=tabs,
email=email,
name=name,
recipient_id=signer_recipient_id,
client_user_id=client_user_id)
signers = [signer]
recipients = docusign.Recipients(signers=signers)
# send the envelope (otherwise it will be "created" in the Draft folder)
status = 'sent'
# create an envelope to be signed
envelope_definition = docusign.EnvelopeDefinition(
email_subject=email_subject,
email_blurb=email_blurb,
documents=documents,
recipients=recipients,
status=status)
envelopes_api = EnvelopesApi()
try:
docusign.configuration.api_client = self.api_client
recipients_update_summary = envelopes_api.update_recipients(
self.user_info.accounts[0].account_id,
self.envelope_id,
recipients=recipients,
resend_envelope='true')
assert recipients_update_summary is not None
assert len(recipients_update_summary.recipient_update_results) > 0
assert (None == recipients_update_summary.
recipient_update_results[0].error_details)
print("RecipientsUpdateSummary: ", end="")
pprint(recipients_update_summary)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testEmbeddedSigning(self):
with open(SignTest1File, 'rb') as sign_file:
file_contents = sign_file.read()
# Set properties and create an envelope later on
email_subject = 'Please Sign my Python SDK Envelope'
email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
base64_doc = base64.b64encode(file_contents).decode("utf-8")
name = 'TestFile.pdf'
document_id = '1'
doc = docusign.Document(document_base64=base64_doc,
name=name,
document_id=document_id)
documents = [doc]
# Add a recipient to sign the document
email = Username
name = 'Pat Developer'
recipient_id_for_doc = '1'
# this value represents the client's unique identifier for the signer
client_user_id = '2939'
# Create a SignHere tab somewhere on the document for the signer to sign
document_id = '1'
page_number = '1'
recipient_id = '1'
x_position = '100'
y_position = '100'
scale_value = '0.5'
# create sign here object with the properties
sign_here = docusign.SignHere(document_id=document_id,
page_number=page_number,
recipient_id=recipient_id,
x_position=x_position,
y_position=y_position,
scale_value=scale_value)
sign_here_tabs = [sign_here]
tabs = docusign.Tabs(sign_here_tabs=sign_here_tabs)
signer = docusign.Signer(email=email,
name=name,
recipient_id=recipient_id_for_doc,
client_user_id=client_user_id,
tabs=tabs)
signers = [signer]
recipients = docusign.Recipients(signers=signers)
status = 'sent'
# create the envelope definition with the properties set
envelope_definition = docusign.EnvelopeDefinition(
email_subject=email_subject,
email_blurb=email_blurb,
documents=documents,
recipients=recipients,
status=status)
envelopes_api = EnvelopesApi()
try:
return_url = 'http://www.docusign.com/developer-center'
recipient_view_request = docusign.RecipientViewRequest()
recipient_view_request.return_url = return_url
recipient_view_request.client_user_id = client_user_id
recipient_view_request.authentication_method = 'email'
recipient_view_request.user_name = 'Pat Developer'
recipient_view_request.email = Username
envelope_summary = envelopes_api.create_envelope(
self.user_info.accounts[0].account_id,
envelope_definition=envelope_definition)
envelope_id = envelope_summary.envelope_id
view_url = envelopes_api.create_recipient_view(
self.user_info.accounts[0].account_id,
envelope_id,
recipient_view_request=recipient_view_request)
assert view_url is not None
assert view_url.url is not None
# This Url should work in an Iframe or browser to allow signing
print("ViewUrl is ", end="")
pprint(view_url)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testCreateTemplate(self):
with open(SignTest1File, 'rb') as sign_file:
file_contents = sign_file.read()
# Set properties
email_subject = 'Please Sign my Python SDK Envelope (Embedded Signer)'
email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the template
base64_doc = base64.b64encode(file_contents).decode("utf-8")
name = 'TestFile.pdf'
document_id = '1'
doc = docusign.Document(document_base64=base64_doc,
name=name,
document_id=document_id)
documents = [doc]
# Add a recipient to sign the document
email = Username
name = 'Pat Developer'
recipient_id = '1'
# Create a SignHere tab somewhere on the document for the signer to sign
sign_document_id = '1'
sign_page_number = '1'
sign_recipient_id = '1'
sign_x_position = '100'
sign_y_position = '100'
sign_scale_value = '0.5'
sign_here = docusign.SignHere(document_id=sign_document_id,
page_number=sign_page_number,
recipient_id=sign_recipient_id,
x_position=sign_x_position,
y_position=sign_y_position,
scale_value=sign_scale_value)
sign_here_tabs = [sign_here]
tabs = docusign.Tabs(sign_here_tabs=sign_here_tabs)
signer = docusign.Signer(email=email,
name=name,
recipient_id=recipient_id,
tabs=tabs)
signers = [signer]
recipients = docusign.Recipients(signers=signers)
template_name = 'myTemplate'
# Create the Envelope template
envelope_template = docusign.EnvelopeTemplate(
email_subject=email_subject,
email_blurb=email_blurb,
documents=documents,
recipients=recipients,
name=template_name)
templates_api = TemplatesApi()
try:
template_summary = templates_api.create_template(
self.user_info.accounts[0].account_id,
envelope_template=envelope_template)
assert template_summary is not None
assert template_summary.template_id is not None
print("TemplateSummary: ", end="")
pprint(template_summary)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testRequestASignature(self):
with open(SignTest1File, 'rb') as sign_file:
file_contents = sign_file.read()
# Set properties and create an envelope later on
email_subject = 'Please Sign my Python SDK Envelope'
email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
doc = docusign.Document()
base64_doc = base64.b64encode(file_contents).decode("utf-8")
doc.document_base64 = base64_doc
doc.name = 'TestFile.pdf'
doc.document_id = '1'
documents = [doc]
# Create a SignHere tab somewhere on the document for the signer to sign
document_id = '1'
page_number = '1'
recipient_id = '1'
x_position = '100'
y_position = '100'
scale_value = '0.5'
sign_here = docusign.SignHere(document_id=document_id,
page_number=page_number,
recipient_id=recipient_id,
x_position=x_position,
y_position=y_position,
scale_value=scale_value)
sign_here_tabs = [sign_here]
tabs = docusign.Tabs(sign_here_tabs=sign_here_tabs)
# Add a recipient to sign the document
email = Username
name = 'Pat Developer'
recipient_id = '1'
signer = docusign.Signer(email=email,
name=name,
recipient_id=recipient_id,
tabs=tabs)
signers = [signer]
recipients = docusign.Recipients(signers=signers)
status = 'sent'
# create the envelope definition with the properties set
envelope_definition = docusign.EnvelopeDefinition(
email_subject=email_subject,
email_blurb=email_blurb,
documents=documents,
recipients=recipients,
status=status)
envelopes_api = EnvelopesApi()
try:
envelope_summary = envelopes_api.create_envelope(
self.user_info.accounts[0].account_id,
envelope_definition=envelope_definition)
assert envelope_summary is not None
assert envelope_summary.envelope_id is not None
assert envelope_summary.status == 'sent'
print("EnvelopeSummary: ", end="")
pprint(envelope_summary)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testMoveEnvelopes(self):
with open(SignTest1File, 'rb') as sign_file:
file_contents = sign_file.read()
# create an envelope to be signed
envelope_definition = docusign.EnvelopeDefinition()
envelope_definition.email_subject = 'Please Sign my Python SDK Envelope'
envelope_definition.email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
doc = docusign.Document()
base64_doc = base64.b64encode(file_contents).decode("utf-8")
doc.document_base64 = base64_doc
doc.name = 'TestFile.pdf'
doc.document_id = '1'
envelope_definition.documents = [doc]
# Add a recipient to sign the document
signer = docusign.Signer()
signer.email = Username
signer.name = 'Pat Developer'
signer.recipient_id = '1'
# Create a SignHere tab somewhere on the document for the signer to sign
sign_here = docusign.SignHere()
sign_here.document_id = '1'
sign_here.page_number = '1'
sign_here.recipient_id = '1'
sign_here.x_position = '100'
sign_here.y_position = '100'
sign_here.scale_value = '0.5'
tabs = docusign.Tabs()
tabs.sign_here_tabs = [sign_here]
signer.tabs = tabs
recipients = docusign.Recipients()
recipients.signers = [signer]
envelope_definition.recipients = recipients
envelope_definition.status = 'sent'
envelopes_api = EnvelopesApi()
try:
envelope_summary = envelopes_api.create_envelope(
self.user_info.accounts[0].account_id,
envelope_definition=envelope_definition)
assert envelope_summary is not None
assert envelope_summary.envelope_id is not None
assert envelope_summary.status == 'sent'
folders_api = FoldersApi()
folders_request = docusign.FoldersRequest(
envelope_ids=[envelope_summary.envelope_id],
from_folder_id="sentitems")
to_folder_id = "draft"
folders_api.move_envelopes(self.user_info.accounts[0].account_id,
to_folder_id,
folders_request=folders_request)
# Wait for 1 second to make sure the newly created envelope was moved to the 'sentitems' folder
# Note: It's discouraged to use sleep statement or to poll DocuSign for envelope status or folder id
# In production, use DocuSign Connect to get notified when the status of the envelope have changed.
sleep(1)
# Test if we moved the envelope to the correct folder
list_from_drafts_folder = folders_api.list_items(
self.user_info.accounts[0].account_id, to_folder_id)
assert list_from_drafts_folder is not None
for item in list_from_drafts_folder.folder_items:
if item.envelope_id == envelope_summary.envelope_id:
return
assert False
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def create_envelope_definition_for_hpa(docs: HPActionDocuments) -> dse.EnvelopeDefinition:
"""
Create a DocuSign envelope definition for the given HP Action documents.
"""
user = docs.user
xml_bytes = docs.xml_file.open().read()
case_type = HPAType.get_from_answers_xml(xml_bytes)
pdf_file = docs.open_emergency_pdf_file()
if not pdf_file:
raise Exception(
"Unable to open emergency HP Action packet (it may only consist " "of instructions)"
)
pdf_bytes = pdf_file.read()
base64_pdf = base64.b64encode(pdf_bytes).decode("ascii")
document = dse.Document(
document_base64=base64_pdf,
name=f"HP Action forms for {user.full_legal_name}",
file_extension="pdf",
document_id=HPA_DOCUMENT_ID,
)
signer = dse.Signer(
email=user.email,
name=user.full_legal_name,
recipient_id=TENANT_RECIPIENT_ID,
routing_order="1",
client_user_id=docusign_client_user_id(user),
)
cfg = FormsConfig.from_case_type(case_type)
cfg.ensure_expected_pages(PyPDF2.PdfFileReader(BytesIO(pdf_bytes)).numPages)
signer.tabs = cfg.to_docusign_tabs(contact_info=get_contact_info(user))
carbon_copies: List[dse.CarbonCopy] = [
dse.CarbonCopy(
email=user.email,
name=user.full_legal_name,
recipient_id="2",
routing_order="2",
)
]
court_contacts = get_court_contacts_for_user(user)
if not court_contacts:
# This is bad, but we can always manually forward the signed document
# to the proper court, so just log an error instead of raising
# an exception.
logger.error(f"No housing court found for user '{user.username}'!")
carbon_copies.extend(
cc_court_contacts(
court_contacts,
initial_recipient_id=3,
routing_order="2",
)
)
envelope_definition = dse.EnvelopeDefinition(
email_subject=f"HP Action forms for {user.full_legal_name}",
documents=[document],
recipients=dse.Recipients(signers=[signer], carbon_copies=carbon_copies),
status="sent",
)
assert isinstance(envelope_definition, dse.EnvelopeDefinition)
return envelope_definition
def testDownLoadEnvelopeDocuments(self):
file_contents = open(sign_test1_file, 'rb').read()
# create an envelope to be signed
envelope_definition = docusign.EnvelopeDefinition()
envelope_definition.email_subject = 'Please Sign my Python SDK Envelope'
envelope_definition.email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
doc = docusign.Document()
base64_doc = base64.b64encode(file_contents).decode("utf-8")
doc.document_base64 = base64_doc
doc.name = 'TestFile.pdf'
doc.document_id = '1'
envelope_definition.documents = [doc]
# Add a recipient to sign the document
signer = docusign.Signer()
signer.email = username
signer.name = 'Pat Developer'
signer.recipient_id = '1'
# this value represents the client's unique identifier for the signer
client_user_id = '2939'
signer.client_user_id = client_user_id
# Create a Text tab somewhere on the document for the signer to sign
text = docusign.Text()
text.document_id = '1'
text.page_number = '1'
text.recipient_id = '1'
text.x_position = '100'
text.y_position = '100'
text.scale_value = '0.5'
tabs = docusign.Tabs()
tabs.text_tabs = [text]
signer.tabs = tabs
recipients = docusign.Recipients()
recipients.signers = [signer]
envelope_definition.recipients = recipients
# send the envelope (otherwise it will be "created" in the Draft folder)
envelope_definition.status = 'sent'
auth_api = AuthenticationApi()
envelopes_api = EnvelopesApi()
try:
login_info = auth_api.login()
assert login_info is not None
assert len(login_info.login_accounts) > 0
login_accounts = login_info.login_accounts
assert login_accounts[0].account_id is not None
base_url, _ = login_accounts[0].base_url.split('/v2')
self.api_client.host = base_url
docusign.configuration.api_client = self.api_client
#do sending
envelope_summary = envelopes_api.create_envelope(
login_accounts[0].account_id,
envelope_definition=envelope_definition)
assert envelope_summary is not None
assert envelope_summary.envelope_id is not None
print("EnvelopeSummary: ", end="")
pprint(envelope_summary)
#do downloading #TODO what 'combined' param means
file = envelopes_api.get_document(login_accounts[0].account_id,
'combined',
envelope_summary.envelope_id)
assert len(file) > 0
print('file=%s' % file)
subprocess.call('open ' + file, shell=True)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception
def testRequestASignature():
username = "******"
password = "******"
integrator_key = "26ec5e49-a531-4457-ab81-163d76f37a17"
BASE_URL = "https://demo.docusign.net/restapi"
user_id = "39c6e30b-3b99-486f-a671-96acc240d7ab"
oauth_base_url = "account-d.docusign.com" # use account.docusign.com for Live/Production
api_client = docusign.ApiClient(BASE_URL)
redirect_uri = "https://www.docusign.com"
private_key_filename = 'private_key2.txt'
# IMPORTANT NOTE:
# the first time you ask for a JWT access token, you should grant access by making the following call
# get DocuSign OAuth authorization url:
oauth_login_url = api_client.get_jwt_uri(integrator_key, redirect_uri,
oauth_base_url)
# open DocuSign OAuth authorization url in the browser, login and grant access
# webbrowser.open_new_tab(oauth_login_url)
print(oauth_login_url)
# END OF NOTE
# configure the ApiClient to asynchronously get an access to token and store it
api_client.configure_jwt_authorization_flow(private_key_filename,
oauth_base_url, integrator_key,
user_id, 3600)
docusign.configuration.api_client = api_client
# sign_test1_file = "test/docs/SignTest1.pdf"
file_contents = open('/Users/lisayoo/Desktop/contract.pdf', 'rb').read()
# create an envelope to be signed
envelope_definition = docusign.EnvelopeDefinition()
envelope_definition.email_subject = "Hi! Here's your annotated contract."
envelope_definition.email_blurb = 'Hello, Please sign my Python SDK Envelope.'
# add a document to the envelope
doc = docusign.Document()
base64_doc = base64.b64encode(file_contents).decode("utf-8")
doc.document_base64 = base64_doc
doc.name = "test.pdf"
doc.document_id = '1'
envelope_definition.documents = [doc]
# Add a recipient to sign the document
signer = docusign.Signer()
signer.email = "*****@*****.**"
signer.name = 'Kat Wicks'
signer.recipient_id = '1'
recipients = docusign.Recipients()
recipients.signers = [signer]
envelope_definition.recipients = recipients
envelope_definition.status = 'sent'
auth_api = AuthenticationApi()
envelopes_api = EnvelopesApi()
try:
login_info = auth_api.login(api_password='******',
include_account_id_guid='true')
assert login_info is not None
assert len(login_info.login_accounts) > 0
login_accounts = login_info.login_accounts
assert login_accounts[0].account_id is not None
base_url, _ = login_accounts[0].base_url.split('/v2')
api_client.host = base_url
docusign.configuration.api_client = api_client
envelope_summary = envelopes_api.create_envelope(
login_accounts[0].account_id,
envelope_definition=envelope_definition)
assert envelope_summary is not None
assert envelope_summary.envelope_id is not None
assert envelope_summary.status == 'sent'
print("EnvelopeSummary: ", end="")
print(envelope_summary)
except ApiException as e:
print("\nException when calling DocuSign API: %s" % e)
assert e is None # make the test case fail in case of an API exception