def make_envelope(cls, args):
"""
Creates envelope
Document: A txt document.
DocuSign will convert document to the PDF format.
"""
# The envelope has two recipients
# Recipient 1 - signer1
# Recipient 2 - signer_2a or signer_2b
# The envelope will be sent first to signer1
# If signer1 doesn't check the checkbox the envelope will be sent to the signer_2a
# If signer1 check the checkbox the envelope will be sent to the signer_2b
# Create the envelope definition
env = EnvelopeDefinition(email_subject="ApproveIfChecked")
# Read file from a local directory
# The reads could raise an exception if the file is not available
with open(path.join(demo_docs_path, DS_CONFIG["doc_txt"]),
"rb") as file:
doc_docx_bytes = file.read()
doc_b64 = base64.b64encode(doc_docx_bytes).decode("ascii")
# Create the document model.
document = Document( # Create the DocuSign document object
document_base64=doc_b64,
name="Welcome", # Can be different from actual file name
file_extension="txt", # Many different document types are accepted
document_id="1" # A label used to reference the doc
)
env.documents = [document, ]
# Create the signer model
# routingOrder (lower means earlier) determines the order of deliveries to the recipients
signer1 = Signer(
email=args["signer1_email"],
name=args["signer1_name"],
recipient_id="1",
routing_order="1",
role_name="Purchaser"
)
signer2 = Signer(
email="*****@*****.**",
name="Approver",
recipient_id="2",
routing_order="2",
role_name="Approver"
)
# Create signHere fieldы (also known as tabs) on the documents
sign_here1 = SignHere(
document_id="1",
page_number="1",
name="SignHere",
tab_label="PurchaserSignature",
x_position="200",
y_position="200"
)
sign_here2 = SignHere(
document_id="1",
page_number="1",
name="SignHere",
recipient_id="2",
tab_label="ApproverSignature",
x_position="300",
y_position="200"
)
# Create checkbox field on the documents
checkbox = Checkbox(
document_id="1",
page_number="1",
name="ClickToApprove",
selected="false",
tab_label="ApproveWhenChecked",
x_position="50",
y_position="50"
)
# Add the tabs models (including the sign_here tabs) to the signer
# The Tabs object wants arrays of the different field/tab types
signer1.tabs = Tabs(
sign_here_tabs=[sign_here1, ],
checkbox_tabs=[checkbox, ]
)
signer2.tabs = Tabs(sign_here_tabs=[sign_here2, ])
# Add the recipients to the envelope object
env_recipients = Recipients(signers=[signer1, signer2])
# env_recipients = Recipients(signers=[signer1, ])
env.recipients = env_recipients
# Create recipientOption models
signer_2a = RecipientOption(
email=args["signer_2a_email"],
name=args["signer_2a_name"],
role_name="Signer when not checked",
recipient_label="signer2a"
)
signer_2b = RecipientOption(
email=args["signer_2b_email"],
name=args["signer_2b_name"],
role_name="Signer when checked",
recipient_label="signer2b"
)
recipients = [signer_2a, signer_2b]
# Create recipientGroup model
recipient_group = RecipientGroup(
group_name="Approver",
group_message="Members of this group approve a workflow",
recipients=recipients
)
# Create conditionalRecipientRuleFilter models
filter1 = ConditionalRecipientRuleFilter(
scope="tabs",
recipient_id="1",
tab_id="ApprovalTab",
operator="equals",
value="false",
tab_label="ApproveWhenChecked"
)
filter2 = ConditionalRecipientRuleFilter(
scope="tabs",
recipient_id="1",
tab_id="ApprovalTab",
operator="equals",
value="true",
tab_label="ApproveWhenChecked"
)
# Create conditionalRecipientRuleCondition models
condition1 = ConditionalRecipientRuleCondition(
filters=[filter1, ],
order="1",
recipient_label="signer2a"
)
condition2 = ConditionalRecipientRuleCondition(
filters=[filter2, ],
order="2",
recipient_label="signer2b"
)
conditions = [condition1, condition2]
# Create conditionalRecipientRule model
conditional_recipient = ConditionalRecipientRule(
conditions=conditions,
recipient_group=recipient_group,
recipient_id="2",
order="0",
)
# Create recipientRules model
rules = RecipientRules(conditional_recipients=[conditional_recipient, ])
recipient_routing = RecipientRouting(rules=rules)
# Create a workflow model
workflow_step = WorkflowStep(
action="pause_before",
trigger_on_item="routing_order",
item_id="2",
status="pending",
recipient_routing=recipient_routing
)
workflow = Workflow(workflow_steps=[workflow_step, ])
# Add the workflow to the envelope object
env.workflow = workflow
# Request that the envelope be sent by setting |status| to "sent"
# To request that the envelope be created as a draft, set to "created"
env.status = args["status"]
return env
def make_envelope(cls, args):
"""
Creates envelope
Document: A txt document.
DocuSign will convert document to the PDF format.
"""
# The envelope has two recipients
# Recipient 1 - signer1
# Recipient 2 - signer2
# The envelope will be sent first to the signer1
# After it is signed, a signature workflow will be paused
# After resuming (unpause) the signature workflow will send to the second recipient
# Create the envelope definition
env = EnvelopeDefinition(email_subject="EnvelopeWorkflowTest")
# Read file from a local directory
# The reads could raise an exception if the file is not available!
with open(path.join(demo_docs_path, DS_CONFIG["doc_txt"]),
"rb") as file:
doc_docx_bytes = file.read()
doc_b64 = base64.b64encode(doc_docx_bytes).decode("ascii")
# Create the document model.
document = Document( # Create the DocuSign document object
document_base64=doc_b64,
name="Welcome", # Can be different from actual file name
file_extension="txt", # Many different document types are accepted
document_id="1" # The label used to reference the doc
)
# The order in the docs array determines the order in the envelope.
env.documents = [
document,
]
# Create the signer recipient models
# routing_order (lower means earlier) determines the order of deliveries
# to the recipients.
signer1 = Signer(email=args["signer1_email"],
name=args["signer1_name"],
recipient_id="1",
routing_order="1")
signer2 = Signer(email=args["signer2_email"],
name=args["signer2_name"],
recipient_id="2",
routing_order="2")
# Create SignHere fields (also known as tabs) on the documents.
sign_here1 = SignHere(document_id="1",
page_number="1",
tab_label="Sign Here",
x_position="200",
y_position="200")
sign_here2 = SignHere(document_id="1",
page_number="1",
tab_label="Sign Here",
x_position="300",
y_position="200")
# Add the tabs model (including the sign_here tabs) to the signer
# The Tabs object takes arrays of the different field/tab types
signer1.tabs = Tabs(sign_here_tabs=[
sign_here1,
])
signer2.tabs = Tabs(sign_here_tabs=[
sign_here2,
])
# Add the recipients to the envelope object
recipients = Recipients(signers=[signer1, signer2])
env.recipients = recipients
# Create a workflow model
# Signature workflow will be paused after it is signed by the first signer
workflow_step = WorkflowStep(action="pause_before",
trigger_on_item="routing_order",
item_id="2")
workflow = Workflow(workflow_steps=[
workflow_step,
])
# Add the workflow to the envelope object
env.workflow = workflow
# Request that the envelope be sent by setting |status| to "sent"
# To request that the envelope be created as a draft, set to "created"
env.status = args["status"]
return env
