def _add_remove_team_member(self, url, email_address=None, account_id=None):
"""Add or Remove a team member
We use this function for two different tasks because they have the same
API call
Args:
email_address (str): Email address of the Account to add/remove
account_id (str): ID of the Account to add/remove
Returns:
True if Account is added/removed successfully, False otherwise
"""
if not email_address and not account_id:
raise HSException("No email address or account_id specified")
elif email_address and not utils.is_email(email_address):
raise InvalidEmail("Email is not valid")
request = HSRequest(self.auth)
data = {}
if account_id is not None:
data = {"account_id": account_id}
else:
data = {"email_address": email_address}
response = request.post(url, data)
return Team(response["team"])
def _add_remove_user_reusable_form(self, url, reusable_form_id,
account_id=None, email_address=None):
"""Add or Remove user from a ReusableForm
We use this function for two tasks because they have the same API call
Args:
reusable_form_id (str): The id of the ReusableForm
account_id (str): ID of the Account to add/remove access to/from
email_address (str): email_address of the Account to add/remove
access to/from
Raises:
HSException: If no email address or account_id specified
Returns:
A ReusableForm object specified by reusable_form_id parameter
"""
if not email_address and not account_id:
raise HSException("No email address or account_id specified")
elif email_address and not utils.is_email(email_address):
raise InvalidEmail("Email is not valid")
request = HSRequest(self.auth)
data = {}
if account_id is not None:
data = {"account_id": account_id}
else:
data = {"email_address": email_address}
request = HSRequest(self.auth)
response = request.post(url + reusable_form_id, data)
return ReusableForm(response["reusable_form"])
def test_call(self):
auth = HSAccessTokenAuth(access_token="at_test",
access_token_type="att_test")
request = HSRequest(auth)
response = request.get(url='http://httpbin.org/headers')
self.assertEquals(response['headers']['Authorization'],
'at_test att_test')
def test_bad_request(self):
request = HSRequest(self.client.auth)
try:
request.post(url=HSClient.ACCOUNT_UPDATE_URL,
data={"bad": "request"})
except BadRequest:
pass
def _add_remove_team_member(self, url, email_address=None, account_id=None):
"""Add or Remove a team member
We use this function for two different tasks because they have the same
API call
Args:
email_address (str): Email address of the Account to add/remove
account_id (str): ID of the Account to add/remove
Returns:
True if Account is added/removed successfully, False otherwise
"""
if email_address is None and account_id is None:
raise HSException("No email address or account_id specified")
request = HSRequest(self.auth)
data = {}
if account_id is not None:
data = {"account_id": account_id}
else:
data = {"email_address": email_address}
try:
request.post(url, data)
except HTTPError:
return False
return True
def test_bad_request(self):
request = HSRequest(self.client.auth)
try:
request.post(url=HSClient.ACCOUNT_UPDATE_URL,
data={"bad": "request"})
except BadRequest:
pass
def _add_remove_user_reusable_form(self, url, reusable_form_id,
account_id=None, email_address=None):
"""Add or Remove user from a ReusableForm
We use this function for two tasks because they have the same API call
Args:
reusable_form_id (str): The id of the ReusableForm
account_id (str): ID of the Account to add/remove access to/from
email_address (str): email_address of the Account to add/remove
access to/from
Raises:
HSException: If no email address or account_id specified
Returns:
A ReusableForm object specified by reusable_form_id parameter
"""
if email_address is None and account_id is None:
raise HSException("No email address or account_id specified")
request = HSRequest(self.auth)
data = {}
if account_id is not None:
data = {"account_id": account_id}
else:
data = {"email_address": email_address}
request = HSRequest(self.auth)
response = request.post(url + reusable_form_id, data)
return ReusableForm(response["reusable_form"])
def update_team_name(self, name):
"""Updates a Team's name
Args:
name (str): The name of your Team
Returns:
A Team object of the updated Team
"""
request = HSRequest(self.auth)
response = request.post(self.TEAM_UPDATE_URL, {"name": name})
return Team(response["team"])
def get_reusable_form(self, reusable_form_id):
"""Gets a ReusableForm which includes a list of Accounts that can access
it
Args:
reusable_form_id (str): The id of the ReusableForm to retrieve
Returns:
A ReusableForm object specified by the id parameter
"""
request = HSRequest(self.auth)
response = request.get(self.REUSABLE_FORM_GET_URL + reusable_form_id)
return ReusableForm(response["reusable_form"])
def get_reusable_form(self, reusable_form_id):
"""Gets a ReusableForm which includes a list of Accounts that can access
it
Args:
reusable_form_id (str): The id of the ReusableForm to retrieve
Returns:
A ReusableForm object specified by the id parameter
"""
request = HSRequest(self.auth)
response = request.get(self.REUSABLE_FORM_GET_URL + reusable_form_id)
return ReusableForm(response["reusable_form"])
def get_team_info(self):
"""Gets your Team and a list of its members
Returns information about your Team as well as a list of its members.
If you do not belong to a Team, a 404 error with an error_name of
"not_found" will be returned.
Returns:
A Team object
"""
request = HSRequest(self.auth)
response = request.get(self.TEAM_INFO_URL)
return Team(response["team"])
def get_team_info(self):
"""Gets your Team and a list of its members
Returns information about your Team as well as a list of its members.
If you do not belong to a Team, a 404 error with an error_name of
"not_found" will be returned.
Returns:
A Team object
"""
request = HSRequest(self.auth)
response = request.get(self.TEAM_INFO_URL)
return Team(response["team"])
def update_account_info(self):
"""Update current account information
At the moment you can only update your callback_url.
Returns:
True if the account is updated successfully, False otherwise
"""
request = HSRequest(self.auth)
try:
request.post(self.ACCOUNT_UPDATE_URL, {
'callback_url': self.account.callback_url})
except HTTPError:
return False
return True
def get_signature_request(self, signature_request_id):
"""Get a signature request by its ID
Args:
signature_request_id (str): The id of the SignatureRequest to
retrieve
Returns:
A SignatureRequest object
"""
request = HSRequest(self.auth)
response = request.get(
self.SIGNATURE_REQUEST_INFO_URL + signature_request_id)
return SignatureRequest(response["signature_request"])
def update_account_info(self):
"""Update current account information
At the moment you can only update your callback_url.
Returns:
True if the account is updated successfully, False otherwise
"""
request = HSRequest(self.auth)
try:
request.post(self.ACCOUNT_UPDATE_URL, {
'callback_url': self.account.callback_url})
except HTTPError:
return False
return True
def get_signature_request(self, signature_request_id):
"""Get a signature request by its ID
Args:
signature_request_id (str): The id of the SignatureRequest to
retrieve
Returns:
A SignatureRequest object
"""
request = HSRequest(self.auth)
response = request.get(
self.SIGNATURE_REQUEST_INFO_URL + signature_request_id)
return SignatureRequest(response["signature_request"])
def get_signature_request_list(self):
"""Get a list of SignatureRequest that you can access
This includes SignatureRequests you have sent as well as received, but
not ones that you have been CCed on.
Returns:
A list of SignatureRequest objects
"""
sr_list = []
request = HSRequest(self.auth)
response = request.get(self.SIGNATURE_REQUEST_LIST_URL)
for signature_request in response["signature_requests"]:
sr_list.append(SignatureRequest(signature_request))
return sr_list
def create_team(self, name):
"""Creates a new Team
Creates a new Team and makes you a member. You must not currently belong
to a Team to invoke.
Args:
name (str): The name of your Team
Returns:
A Team object of the newly created Team
"""
request = HSRequest(self.auth)
response = request.post(self.TEAM_CREATE_URL, {"name": name})
return Team(response["team"])
def create_team(self, name):
"""Creates a new Team
Creates a new Team and makes you a member. You must not currently belong
to a Team to invoke.
Args:
name (str): The name of your Team
Returns:
A Team object of the newly created Team
"""
request = HSRequest(self.auth)
response = request.post(self.TEAM_CREATE_URL, {"name": name})
return Team(response["team"])
def destroy_team(self):
"""Delete your Team
Deletes your Team. Can only be invoked when you have a Team with only
one member (yourself).
Returns:
True if the Team is deleted successfully, False otherwise
"""
request = HSRequest(self.auth)
try:
request.post(self.TEAM_DESTROY_URL)
except HTTPError:
return False
return True
def update_team_name(self, name):
"""Updates a Team's name
Args:
name (str): The name of your Team
Returns:
True if the Team is updated successfully, False otherwise
"""
request = HSRequest(self.auth)
try:
request.post(self.TEAM_UPDATE_URL, {"name": name})
except HTTPError:
return False
return True
def destroy_team(self):
"""Delete your Team
Deletes your Team. Can only be invoked when you have a Team with only
one member (yourself).
Returns:
True if the Team is deleted successfully, False otherwise
"""
request = HSRequest(self.auth)
try:
request.post(self.TEAM_DESTROY_URL)
except HTTPError:
return False
return True
def get_signature_request_list(self):
"""Get a list of SignatureRequest that you can access
This includes SignatureRequests you have sent as well as received, but
not ones that you have been CCed on.
Returns:
A list of SignatureRequest objects
"""
sr_list = []
request = HSRequest(self.auth)
response = request.get(self.SIGNATURE_REQUEST_LIST_URL)
for signature_request in response["signature_requests"]:
sr_list.append(SignatureRequest(signature_request))
return sr_list
def test_get(self):
request = HSRequest(self.client.auth)
response = request.get(url='http://httpbin.org/get',
headers={'Custom-Header': 'Nothing'},
parameters={'param': 'Nothing'},
get_json=False)
self.assertEquals(response.status_code, 200)
response = request.get(url='http://httpbin.org/get',
get_json=True)
self.assertEquals(isinstance(response, dict), True)
response = request.get(url='https://httpbin.org/get',
headers={'Custom-Header': 'Nothing'},
parameters={'param': 'Nothing'},
get_json=False)
self.assertEquals(response.status_code, 200)
response = request.get(url='https://httpbin.org/get',
get_json=True)
self.assertEquals(isinstance(response, dict), True)
try:
response = request.get(url='https://www.hellosign.com/oauth/token',
get_json=True)
except BadRequest, e:
self.assertEquals('400 error' in str(e), True)
def get_embeded_object(self, signature_id):
"""Retrieves a embedded signing object
Retrieves an embedded object containing a signature url that can be
opened in an iFrame
Args:
signature_id (str): The id of the signature to get a signature url
for
Returns:
An Embedded object specified by signature_id
"""
request = HSRequest(self.auth)
response = request.get(self.EMBEDDED_OBJECT_GET_URL + signature_id)
return Embedded(response["embedded"])
def get_signature_request_file(self, signature_request_id, filename):
"""Download the PDF copy of the current documents
Args:
signature_request_id (str): ID of the Signature Request
filename (str): Filename to save the PDF file to. This should be a
full path.
Returns:
True if file is downloaded and written successfully, False
otherwise.
"""
request = HSRequest(self.auth)
return request.get_file(
self.SIGNATURE_REQUEST_DOWNLOAD_PDF_URL + signature_request_id,
filename)
def get_signature_request_file(self, signature_request_id, filename):
"""Download the PDF copy of the current documents
Args:
signature_request_id (str): ID of the Signature Request
filename (str): Filename to save the PDF file to. This should be a
full path.
Returns:
True if file is downloaded and written successfully, False
otherwise.
"""
request = HSRequest(self.auth)
return request.get_file(
self.SIGNATURE_REQUEST_DOWNLOAD_PDF_URL + signature_request_id,
filename)
def get_embeded_object(self, signature_id):
"""Retrieves a embedded signing object
Retrieves an embedded object containing a signature url that can be
opened in an iFrame
Args:
signature_id (str): The id of the signature to get a signature url
for
Returns:
An Embedded object specified by signature_id
"""
request = HSRequest(self.auth)
response = request.get(self.EMBEDDED_OBJECT_GET_URL + signature_id)
return Embedded(response["embedded"])
def get_reusable_form_list(self, page=1):
"""Lists your ReusableForms
Args:
page (int, optional): Which page number of the ReusableForm List to
return. Defaults to 1.
Returns:
A list the ReusableForms that are accessible by you
"""
rf_list = []
request = HSRequest(self.auth)
response = request.get(
self.REUSABLE_FORM_GET_LIST_URL, parameters={"page": page})
for reusable_form in response["reusable_forms"]:
rf_list.append(ReusableForm(reusable_form))
return rf_list
def get_reusable_form_list(self, page=1):
"""Lists your ReusableForms
Args:
page (int, optional): Which page number of the ReusableForm List to
return. Defaults to 1.
Returns:
A list the ReusableForms that are accessible by you
"""
rf_list = []
request = HSRequest(self.auth)
response = request.get(
self.REUSABLE_FORM_GET_LIST_URL, parameters={"page": page})
for reusable_form in response["reusable_forms"]:
rf_list.append(ReusableForm(reusable_form))
return rf_list
def test_get_file(self):
request = HSRequest(self.client.auth)
f = tempfile.NamedTemporaryFile(delete=True)
temp_filename = f.name
f.close()
response = request.get_file(url='http://httpbin.org/robots.txt',
headers={'Custom-Header': 'Nothing'},
filename=temp_filename)
os.unlink(temp_filename)
self.assertEquals(response, True)
response = request.get_file(url='https://httpbin.org/robots.txt',
headers={'Custom-Header': 'Nothing'},
filename=temp_filename)
os.unlink(temp_filename)
self.assertEquals(response, True)
response = request.get_file(url='http://httpbin.org/robots.txt',
headers={'Custom-Header': 'Nothing'},
filename='')
self.assertEquals(response, False)
response = request.get_file(url='https://httpbin.org/robots.txt',
headers={'Custom-Header': 'Nothing'},
filename='')
self.assertEquals(response, False)
def get_account_info(self):
"""Get current account information
The information then will be saved in `self.account` so that you can
access the information like this:
>>> hsclient = HSClient()
>>> hsclient.get_account_info()
>>> print hsclient.account.email_address
Returns:
True if the information fetched successfully, False otherwise
"""
request = HSRequest(self.auth)
try:
response = request.get(self.ACCOUNT_INFO_URL)
self.account.json_data = response["account"]
except HTTPError:
return False
return True
def cancel_signature_request(self, signature_request_id):
"""Cancels a SignatureRequest
Cancels a SignatureRequest. After canceling, no one will be able to sign
or access the SignatureRequest or its documents. Only the requester can
cancel and only before everyone has signed.
Args:
signing_request_id (str): The id of the SignatureRequest to cancel
Returns:
True if the cancellation is successful, False otherwise
"""
request = HSRequest(self.auth)
try:
request.post(
self.SIGNATURE_REQUEST_CANCEL_URL + signature_request_id)
except HTTPError:
return False
return True
def create_account(self, email, password):
"""Create a new account
Args:
email (str): Email address of the new account to create
password (str): Password of the new account
Returns:
New Account object if successful
"""
if email is None:
raise InvalidEmail("Email cannot be empty")
elif not utils.is_email(email):
raise InvalidEmail("Email is not valid")
if password is None:
raise EmptyPassword("Password cannot be empty")
request = HSRequest(self.auth)
response = request.post(self.ACCOUNT_CREATE_URL, {
'email_address': email, 'password': password})
return Account(response["account"])
def get_oauth_data(self, code, client_id, secret, state):
"""Get Oauth data from HelloSign
Args:
code (str): Code returned by HelloSign for our callback url
client_id (str):
secret (str):
Returns:
An HSAccessTokenAuth object
"""
request = HSRequest(self.auth)
response = request.post(self.OAUTH_TOKEN_URL, {"state": state,
"code": code,
"grant_type": "authorization_code",
"client_id": client_id, "secret": secret})
oauth = HSAccessTokenAuth(
response['access_token'],
response['token_type'], response['refresh_token'],
response['expires_in'], response['state'])
return oauth
def get_account_info(self):
"""Get current account information
The information then will be saved in `self.account` so that you can
access the information like this:
>>> hsclient = HSClient()
>>> hsclient.get_account_info()
>>> print hsclient.account.email_address
Returns:
True if the information fetched successfully, False otherwise
"""
request = HSRequest(self.auth)
try:
response = request.get(self.ACCOUNT_INFO_URL)
self.account.json_data = response["account"]
except HTTPError:
return False
return True
def create_account(self, email, password):
"""Create a new account
Args:
email (str): Email address of the new account to create
password (str): Password of the new account
Returns:
New Account object if successful
"""
if not email:
raise InvalidEmail("Email cannot be empty")
elif not utils.is_email(email):
raise InvalidEmail("Email is not valid")
if not password:
raise EmptyPassword("Password cannot be empty")
request = HSRequest(self.auth)
response = request.post(self.ACCOUNT_CREATE_URL, {
'email_address': email, 'password': password})
return Account(response["account"])
def get_oauth_data(self, code, client_id, secret, state):
"""Get Oauth data from HelloSign
Args:
code (str): Code returned by HelloSign for our callback url
client_id (str):
secret (str):
Returns:
An HSAccessTokenAuth object
"""
request = HSRequest(self.auth)
response = request.post(self.OAUTH_TOKEN_URL, {"state": state,
"code": code,
"grant_type": "authorization_code",
"client_id": client_id, "secret": secret})
oauth = HSAccessTokenAuth(
response['access_token'],
response['token_type'], response['refresh_token'],
response['expires_in'], response['state'])
return oauth
def cancel_signature_request(self, signature_request_id):
"""Cancels a SignatureRequest
Cancels a SignatureRequest. After canceling, no one will be able to sign
or access the SignatureRequest or its documents. Only the requester can
cancel and only before everyone has signed.
Args:
signing_request_id (str): The id of the SignatureRequest to cancel
Returns:
True if the cancellation is successful, False otherwise
"""
request = HSRequest(self.auth)
try:
request.post(
self.SIGNATURE_REQUEST_CANCEL_URL + signature_request_id)
except HTTPError:
return False
return True
def get_signature_request_final_copy(self, signature_request_id, filename):
# This api call is DEPRECATED
"""Download the PDF copy of the finalized documents
Download the PDF copy of the finalized documents specified by the
`signature_request_id` parameter
Warning: This API call is deprecated. Use `get_signature_request_file`
instead.
Args:
signature_request_id (str): ID of the Signature Request
filename (str): Filename to save the PDF file to. This should be a
full path.
Returns:
True if file is downloaded and written successfully, False
otherwise.
"""
request = HSRequest(self.auth)
return request.get_file(
self.SIGNATURE_REQUEST_DOWNLOAD_FINAL_COPY_URL +
signature_request_id, filename)
def remind_signature_request(self, signature_request_id, email_address):
"""Sends an email to the signer reminding them to sign the signature
request
Sends an email to the signer reminding them to sign the signature
request. You cannot send a reminder within 1 hours of the last reminder
that was sent. This includes manual AND automatic reminders.
Args:
signature_request_id (str): The id of the SignatureRequest to send a
reminder for
email_address (str): The email address of the signer to send a
reminder to
Returns:
A SignatureRequest object of the requested signature_request_id
"""
request = HSRequest(self.auth)
response = request.post(self.SIGNATURE_REQUEST_REMIND_URL +
signature_request_id,
data={"email_address": email_address})
return SignatureRequest(response["signature_request"])
def remind_signature_request(self, signature_request_id, email_address):
"""Sends an email to the signer reminding them to sign the signature
request
Sends an email to the signer reminding them to sign the signature
request. You cannot send a reminder within 1 hours of the last reminder
that was sent. This includes manual AND automatic reminders.
Args:
signature_request_id (str): The id of the SignatureRequest to send a
reminder for
email_address (str): The email address of the signer to send a
reminder to
Returns:
A SignatureRequest object of the requested signature_request_id
"""
request = HSRequest(self.auth)
response = request.post(self.SIGNATURE_REQUEST_REMIND_URL +
signature_request_id,
data={"email_address": email_address})
return SignatureRequest(response["signature_request"])
def get_signature_request_final_copy(self, signature_request_id, filename):
# This api call is DEPRECATED
"""Download the PDF copy of the finalized documents
Download the PDF copy of the finalized documents specified by the
`signature_request_id` parameter
Warning: This API call is deprecated. Use `get_signature_request_file`
instead.
Args:
signature_request_id (str): ID of the Signature Request
filename (str): Filename to save the PDF file to. This should be a
full path.
Returns:
True if file is downloaded and written successfully, False
otherwise.
"""
request = HSRequest(self.auth)
return request.get_file(
self.SIGNATURE_REQUEST_DOWNLOAD_FINAL_COPY_URL +
signature_request_id, filename)
def test_post(self):
request = HSRequest(self.client.auth)
response = request.post(url='http://httpbin.org/post',
data={"test": "None"}, get_json=False,
headers={'Custom-Header': 'Nothing'}
)
self.assertEquals(response.status_code, 200)
response = request.post(url='http://httpbin.org/post',
data={"test": "None"}, get_json=True
)
response = request.post(url='https://httpbin.org/post',
data={"test": "None"}, get_json=False,
headers={'Custom-Header': 'Nothing'}
)
self.assertEquals(response.status_code, 200)
response = request.post(url='https://httpbin.org/post',
data={"test": "None"}, get_json=True
)
def create_unclaimed_draft(
self, test_mode="0", client_id=None, is_for_embedded_signing="0",
requester_email_address=None,
files=None, file_urls=None, draft_type=None, subject=None,
message=None, signers=None, cc_email_addresses=None,
signing_redirect_url=None, form_fields_per_document=None):
"""Creates a new Draft that can be claimed using the claim URL
Creates a new Draft that can be claimed using the claim URL. The first
authenticated user to access the URL will claim the Draft and will be
shown either the "Sign and send" or the "Request signature" page with
the Draft loaded. Subsequent access to the claim URL will result in a
404. If the type is "send_document" then only the file parameter is
required. If the type is "request_signature", then the identities of the
signers and optionally the location of signing elements on the page are
also required.
Args:
test_mode (str, optional): Whether this is a test, the signature
request created from this draft will not be legally binding if
set to 1. Defaults to 0.
client_id (str): Client id of the app you're using to create this
embedded signature request. Visit the embedded page to learn
more about this parameter. Used for embedded unclaimed draft
(https://www.hellosign.com/api/embedded)
is_for_embedded_signing (str): Used for embedded unclaimed draft
requester_email_address (str):
files (list of str): the uploaded file(s) to send for signature
file_urls (list of str): urls of the file for HelloSign to download
to send for signature. Use either `files` or `file_urls`
type (str): The type of unclaimed draft to create. Use
"send_document" to create a claimable file, and
"request_signature" for a claimable signature request. If the
type is "request_signature" then signers name and email_address
are not optional.
subject (str, optional): The subject in the email that will be sent
to the signers
message (str, optional): The custom message in the email that will
be sent to the signers
signers (list of dict): A list of signers, which each has the
following attributes:
name (str): The name of the signer
email_address (str): email address of the signer
order (str, optional): The order the signer is required to sign
in
cc_email_addresses (list of str, optional): A list of email
addresses that should be CCed
signing_redirect_url (str, optional): The URL you want the signer
redirected to after they successfully sign.
form_fields_per_document (str): The fields that should appear on the
document, expressed as a serialized JSON data structure which is
a list of lists of the form fields. Please refer to the API
reference of HelloSign for more details
(https://www.hellosign.com/api/reference#SignatureRequest)
Retruns:
A UnclaimedDraft object of the newly created Draft
"""
files_payload = {}
for idx, filename in enumerate(files):
files_payload["file[" + str(idx) + "]"] = open(filename, 'rb')
file_urls_payload = {}
for idx, fileurl in enumerate(file_urls):
file_urls_payload["file_url[" + str(idx) + "]"] = fileurl
signers_payload = {}
for idx, signer in enumerate(signers):
if draft_type == UnclaimedDraft.UNCLAIMED_DRAFT_REQUEST_SIGNATURE_TYPE:
if "name" not in signer and "email_address" not in signer:
raise HSException("Signer's name and email are required")
else:
signers_payload[
"signers[" + str(idx) + "][name]"] = signer["name"]
signers_payload["signers[" + str(idx) + "][email_address]"] = signer[
"email_address"]
if "order" in signer:
signers_payload[
"signers[" + str(idx) + "][order]"] = signer["order"]
cc_email_addresses_payload = {}
for idx, cc_email_address in enumerate(cc_email_addresses):
cc_email_addresses_payload[
"cc_email_addresses[" + str(idx) + "]"] = cc_email_address
payload = {
"test_mode": test_mode, "type": draft_type,
"subject": subject, "message": message,
"signing_redirect_url": signing_redirect_url,
"form_fields_per_document": form_fields_per_document}
url = self.UNCLAIMED_DRAFT_CREATE_URL
if is_for_embedded_signing == '1':
payload['is_for_embedded_signing'] = '1'
payload['client_id'] = client_id
payload['requester_email_address'] = requester_email_address
url = self.UNCLAIMED_DRAFT_CREATE_EMBEDDED_URL
# remove attributes with none value
payload = dict((key, value)
for key, value in payload.iteritems() if value)
request = HSRequest(self.auth)
response = request.post(
url, data=dict(
payload.items() + signers_payload.items() +
cc_email_addresses_payload.items() + file_urls_payload.items()),
files=files_payload)
return UnclaimedDraft(response["unclaimed_draft"])
def test_post(self):
request = HSRequest(self.client.auth)
response = request.post(url='https://www.hellosign.com/',
data={"test": "None"},
get_json=False)
self.assertEquals(response.status_code, 200)
def _send_signature_request_with_rf(self, test_mode="0", client_id=None,
reusable_form_id=None, title=None,
subject=None, message=None,
signing_redirect_url=None, signers=None,
ccs=None, custom_fields=None):
"""To share the same logic between send_signature_request_with_rf and
send_signature_request_embedded_with_rf
Args:
test_mode (str, optional): Whether this is a test, the signature
request will not be legally binding if set to 1. Defaults to 0.
client_id (str): Client id of the app you're using to create this
embedded signature request. Visit the embedded page to learn
more about this parameter
(https://www.hellosign.com/api/embedded)
reusable_form_id (str): The id of the ReusableForm to use when
creating the SignatureRequest.
title (str, optional): The title you want to assign to the
SignatureRequest
subject (str, optional): The subject in the email that will be sent
to the signers
message (str, optional): The custom message in the email that will
be sent to the signers
signing_redirect_url (str, optional): The URL you want the signer
redirected to after they successfully sign.
signers (list of dict): A list of signers, which each has the
following attributes:
name (str): The name of the signer
email_address (str): email address of the signer
pin (str, optional): The 4-digit code that will secure this
signer's signature page. You must have a business plan to
use this feature
ccs (list of str, optional): The email address of the CC filling the
role of RoleName. Required when a CC role exists for the
ReusableForm. Each dict has the following attributes:
role_name (str):
email_address (str):
custom_fields (list of dict, optional): A list of custom fields.
Required when a CustomField exists in the ReusableForm. An item
of the list should look like this: `{'name: value'}`
Retruns:
A SignatureRequest object of the newly created Signature Request
"""
signers_payload = {}
for signer in signers:
signers_payload[
"signers[" + signer["role_name"] + "][name]"] = signer["name"]
signers_payload["signers[" + signer["role_name"] + "][email_address]"] = signer[
"email_address"]
if "pin" in signer:
signers_payload[
"signers[" + signer["role_name"] + "][pin]"] = signer["pin"]
ccs_payload = {}
for cc in ccs:
# cc_emaiL_address: {"email_address": "*****@*****.**",
# "role_name": "Role Name"}
ccs_payload[
"ccs[" + cc["role_name"] + "][email_address]"] = cc["email_address"]
custom_fields_payload = {}
# custom_field: {"name": value}
for custom_field in custom_fields:
for key, value in custom_field.iteritems():
custom_fields_payload["custom_fields[" + key + "]"] = value
payload = {
"test_mode": test_mode, "client_id": client_id,
"reusable_form_id": reusable_form_id, "title": title,
"subject": subject, "message": message,
"signing_redirect_url": signing_redirect_url}
# remove attributes with empty value
payload = dict((key, value)
for key, value in payload.iteritems() if value)
request = HSRequest(self.auth)
url = self.SIGNATURE_REQUEST_CREATE_WITH_RF_URL
if client_id:
url = self.SIGNATURE_REQUEST_CREATE_EMBEDDED_WITH_RF_URL
response = request.post(
url, data=dict(
payload.items() + signers_payload.items() +
ccs_payload.items() + custom_fields_payload.items()))
return SignatureRequest(response["signature_request"])
def test_post(self):
request = HSRequest(self.client.auth)
response = request.post(url='https://www.hellosign.com/',
data={"test": "None"}, get_json=False)
self.assertEquals(response.status_code, 200)
def _send_signature_request(self, test_mode="0", client_id=None, files=None,
file_urls=None, title=None, subject=None,
message=None, signing_redirect_url=None,
signers=None, cc_email_addresses=None,
form_fields_per_document=None):
"""To share the same logic between send_signature_request &
send_signature_request_embedded functions
Args:
test_mode (str, optional): Whether this is a test, the signature
request will not be legally binding if set to 1. Defaults to 0.
client_id (str): Client id of the app you're using to create this
embedded signature request. Visit the embedded page to learn
more about this parameter
(https://www.hellosign.com/api/embedded)
files (list of str): the uploaded file(s) to send for signature
file_urls (list of str): urls of the file for HelloSign to download
to send for signature. Use either `files` or `file_urls`
title (str, optional): The title you want to assign to the
SignatureRequest
subject (str, optional): The subject in the email that will be sent
to the signers
message (str, optional): The custom message in the email that will
be sent to the signers
signing_redirect_url (str, optional): The URL you want the signer
redirected to after they successfully sign.
signers (list of dict): A list of signers, which each has the
following attributes:
name (str): The name of the signer
email_address (str): email address of the signer
order (str, optional): The order the signer is required to sign
in
pin (str, optional): The 4-digit code that will secure this
signer's signature page. You must have a business plan to
use this feature
cc_email_addresses (list of str, optional): A list of email
addresses that should be CCed
form_fields_per_document (str): The fields that should appear on the
document, expressed as a serialized JSON data structure which is
a list of lists of the form fields. Please refer to the API
reference of HelloSign for more details
(https://www.hellosign.com/api/reference#SignatureRequest)
Retruns:
A SignatureRequest object of the newly created Signature Request
"""
files_payload = {}
for idx, filename in enumerate(files):
files_payload["file[" + str(idx) + "]"] = open(filename, 'rb')
file_urls_payload = {}
for idx, fileurl in enumerate(file_urls):
file_urls_payload["file_url[" + str(idx) + "]"] = fileurl
signers_payload = {}
for idx, signer in enumerate(signers):
signers_payload["signers[" + str(idx) + "][name]"] = signer["name"]
signers_payload["signers[" + str(idx) + "][email_address]"] = signer[
"email_address"]
if "order" in signer:
signers_payload[
"signers[" + str(idx) + "][order]"] = signer["order"]
if "pin" in signer:
signers_payload[
"signers[" + str(idx) + "][pin]"] = signer["pin"]
cc_email_addresses_payload = {}
for idx, cc_email_address in enumerate(cc_email_addresses):
cc_email_addresses_payload[
"cc_email_addresses[" + str(idx) + "]"] = cc_email_address
payload = {
"test_mode": test_mode, "client_id": client_id, "title": title,
"subject": subject, "message": message,
"signing_redirect_url": signing_redirect_url,
"form_fields_per_document": form_fields_per_document}
# remove attributes with none value
payload = dict((key, value)
for key, value in payload.iteritems() if value)
request = HSRequest(self.auth)
url = self.SIGNATURE_REQUEST_CREATE_URL
if client_id:
url = self.SIGNATURE_REQUEST_CREATE_EMBEDDED_URL
response = request.post(
url, data=dict(
payload.items() + signers_payload.items() +
cc_email_addresses_payload.items() + file_urls_payload.items()),
files=files_payload)
return SignatureRequest(response["signature_request"])
def _send_signature_request(self, test_mode="0", client_id=None, files=None,
file_urls=None, title=None, subject=None,
message=None, signing_redirect_url=None,
signers=None, cc_email_addresses=None,
form_fields_per_document=None):
"""To share the same logic between send_signature_request &
send_signature_request_embedded functions
Args:
test_mode (str, optional): Whether this is a test, the signature
request will not be legally binding if set to 1. Defaults to 0.
client_id (str): Client id of the app you're using to create this
embedded signature request. Visit the embedded page to learn
more about this parameter
(https://www.hellosign.com/api/embedded)
files (list of str): the uploaded file(s) to send for signature
file_urls (list of str): urls of the file for HelloSign to download
to send for signature. Use either `files` or `file_urls`
title (str, optional): The title you want to assign to the
SignatureRequest
subject (str, optional): The subject in the email that will be sent
to the signers
message (str, optional): The custom message in the email that will
be sent to the signers
signing_redirect_url (str, optional): The URL you want the signer
redirected to after they successfully sign.
signers (list of dict): A list of signers, which each has the
following attributes:
name (str): The name of the signer
email_address (str): email address of the signer
order (str, optional): The order the signer is required to sign
in
pin (str, optional): The 4-digit code that will secure this
signer's signature page. You must have a business plan to
use this feature
cc_email_addresses (list of str, optional): A list of email
addresses that should be CCed
form_fields_per_document (str): The fields that should appear on the
document, expressed as a serialized JSON data structure which is
a list of lists of the form fields. Please refer to the API
reference of HelloSign for more details
(https://www.hellosign.com/api/reference#SignatureRequest)
Retruns:
A SignatureRequest object of the newly created Signature Request
"""
files_payload = {}
for idx, filename in enumerate(files):
files_payload["file[" + str(idx) + "]"] = open(filename, 'rb')
file_urls_payload = {}
for idx, fileurl in enumerate(file_urls):
file_urls_payload["file_url[" + str(idx) + "]"] = fileurl
signers_payload = {}
for idx, signer in enumerate(signers):
signers_payload["signers[" + str(idx) + "][name]"] = signer["name"]
signers_payload["signers[" + str(idx) + "][email_address]"] = signer[
"email_address"]
if "order" in signer:
signers_payload[
"signers[" + str(idx) + "][order]"] = signer["order"]
if "pin" in signer:
signers_payload[
"signers[" + str(idx) + "][pin]"] = signer["pin"]
cc_email_addresses_payload = {}
for idx, cc_email_address in enumerate(cc_email_addresses):
cc_email_addresses_payload[
"cc_email_addresses[" + str(idx) + "]"] = cc_email_address
payload = {
"test_mode": test_mode, "client_id": client_id, "title": title,
"subject": subject, "message": message,
"signing_redirect_url": signing_redirect_url,
"form_fields_per_document": form_fields_per_document}
# remove attributes with none value
payload = dict((key, value)
for key, value in payload.iteritems() if value)
request = HSRequest(self.auth)
url = self.SIGNATURE_REQUEST_CREATE_URL
if client_id:
url = self.SIGNATURE_REQUEST_CREATE_EMBEDDED_URL
response = request.post(
url, data=dict(
payload.items() + signers_payload.items() +
cc_email_addresses_payload.items() + file_urls_payload.items()),
files=files_payload)
return SignatureRequest(response["signature_request"])
def create_unclaimed_draft(
self, test_mode="0", client_id=None, is_for_embedded_signing="0",
requester_email_address=None,
files=None, file_urls=None, draft_type=None, subject=None,
message=None, signers=None, cc_email_addresses=None,
signing_redirect_url=None, form_fields_per_document=None):
"""Creates a new Draft that can be claimed using the claim URL
Creates a new Draft that can be claimed using the claim URL. The first
authenticated user to access the URL will claim the Draft and will be
shown either the "Sign and send" or the "Request signature" page with
the Draft loaded. Subsequent access to the claim URL will result in a
404. If the type is "send_document" then only the file parameter is
required. If the type is "request_signature", then the identities of the
signers and optionally the location of signing elements on the page are
also required.
Args:
test_mode (str, optional): Whether this is a test, the signature
request created from this draft will not be legally binding if
set to 1. Defaults to 0.
client_id (str): Client id of the app you're using to create this
embedded signature request. Visit the embedded page to learn
more about this parameter. Used for embedded unclaimed draft
(https://www.hellosign.com/api/embedded)
is_for_embedded_signing (str): Used for embedded unclaimed draft
requester_email_address (str):
files (list of str): the uploaded file(s) to send for signature
file_urls (list of str): urls of the file for HelloSign to download
to send for signature. Use either `files` or `file_urls`
type (str): The type of unclaimed draft to create. Use
"send_document" to create a claimable file, and
"request_signature" for a claimable signature request. If the
type is "request_signature" then signers name and email_address
are not optional.
subject (str, optional): The subject in the email that will be sent
to the signers
message (str, optional): The custom message in the email that will
be sent to the signers
signers (list of dict): A list of signers, which each has the
following attributes:
name (str): The name of the signer
email_address (str): email address of the signer
order (str, optional): The order the signer is required to sign
in
cc_email_addresses (list of str, optional): A list of email
addresses that should be CCed
signing_redirect_url (str, optional): The URL you want the signer
redirected to after they successfully sign.
form_fields_per_document (str): The fields that should appear on the
document, expressed as a serialized JSON data structure which is
a list of lists of the form fields. Please refer to the API
reference of HelloSign for more details
(https://www.hellosign.com/api/reference#SignatureRequest)
Retruns:
A UnclaimedDraft object of the newly created Draft
"""
files_payload = {}
for idx, filename in enumerate(files):
files_payload["file[" + str(idx) + "]"] = open(filename, 'rb')
file_urls_payload = {}
for idx, fileurl in enumerate(file_urls):
file_urls_payload["file_url[" + str(idx) + "]"] = fileurl
signers_payload = {}
for idx, signer in enumerate(signers):
if draft_type == UnclaimedDraft.UNCLAIMED_DRAFT_REQUEST_SIGNATURE_TYPE:
if "name" not in signer and "email_address" not in signer:
raise HSException("Signer's name and email are required")
else:
signers_payload[
"signers[" + str(idx) + "][name]"] = signer["name"]
signers_payload["signers[" + str(idx) + "][email_address]"] = signer[
"email_address"]
if "order" in signer:
signers_payload[
"signers[" + str(idx) + "][order]"] = signer["order"]
cc_email_addresses_payload = {}
for idx, cc_email_address in enumerate(cc_email_addresses):
cc_email_addresses_payload[
"cc_email_addresses[" + str(idx) + "]"] = cc_email_address
payload = {
"test_mode": test_mode, "type": draft_type,
"subject": subject, "message": message,
"signing_redirect_url": signing_redirect_url,
"form_fields_per_document": form_fields_per_document}
url = self.UNCLAIMED_DRAFT_CREATE_URL
if is_for_embedded_signing == '1':
payload['is_for_embedded_signing'] = '1'
payload['client_id'] = client_id
payload['requester_email_address'] = requester_email_address
url = self.UNCLAIMED_DRAFT_CREATE_EMBEDDED_URL
# remove attributes with none value
payload = dict((key, value)
for key, value in payload.iteritems() if value)
request = HSRequest(self.auth)
response = request.post(
url, data=dict(
payload.items() + signers_payload.items() +
cc_email_addresses_payload.items() + file_urls_payload.items()),
files=files_payload)
return UnclaimedDraft(response["unclaimed_draft"])
def test_not_found(self):
request = HSRequest(self.client.auth)
try:
request.get(url=HSClient.API_URL + "/not/found")
except NotFound:
pass
def test_not_authorized(self):
request = HSRequest(HTTPBasicAuth("test", ''))
try:
request.get(HSClient.ACCOUNT_INFO_URL)
except Unauthorized:
pass
def _send_signature_request_with_rf(self, test_mode="0", client_id=None,
reusable_form_id=None, title=None,
subject=None, message=None,
signing_redirect_url=None, signers=None,
ccs=None, custom_fields=None):
"""To share the same logic between send_signature_request_with_rf and
send_signature_request_embedded_with_rf
Args:
test_mode (str, optional): Whether this is a test, the signature
request will not be legally binding if set to 1. Defaults to 0.
client_id (str): Client id of the app you're using to create this
embedded signature request. Visit the embedded page to learn
more about this parameter
(https://www.hellosign.com/api/embedded)
reusable_form_id (str): The id of the ReusableForm to use when
creating the SignatureRequest.
title (str, optional): The title you want to assign to the
SignatureRequest
subject (str, optional): The subject in the email that will be sent
to the signers
message (str, optional): The custom message in the email that will
be sent to the signers
signing_redirect_url (str, optional): The URL you want the signer
redirected to after they successfully sign.
signers (list of dict): A list of signers, which each has the
following attributes:
name (str): The name of the signer
email_address (str): email address of the signer
pin (str, optional): The 4-digit code that will secure this
signer's signature page. You must have a business plan to
use this feature
ccs (list of str, optional): The email address of the CC filling the
role of RoleName. Required when a CC role exists for the
ReusableForm. Each dict has the following attributes:
role_name (str):
email_address (str):
custom_fields (list of dict, optional): A list of custom fields.
Required when a CustomField exists in the ReusableForm. An item
of the list should look like this: `{'name: value'}`
Retruns:
A SignatureRequest object of the newly created Signature Request
"""
signers_payload = {}
for signer in signers:
signers_payload[
"signers[" + signer["role_name"] + "][name]"] = signer["name"]
signers_payload["signers[" + signer["role_name"] + "][email_address]"] = signer[
"email_address"]
if "pin" in signer:
signers_payload[
"signers[" + signer["role_name"] + "][pin]"] = signer["pin"]
ccs_payload = {}
for cc in ccs:
# cc_emaiL_address: {"email_address": "*****@*****.**",
# "role_name": "Role Name"}
ccs_payload[
"ccs[" + cc["role_name"] + "][email_address]"] = cc["email_address"]
custom_fields_payload = {}
# custom_field: {"name": value}
for custom_field in custom_fields:
for key, value in custom_field.iteritems():
custom_fields_payload["custom_fields[" + key + "]"] = value
payload = {
"test_mode": test_mode, "client_id": client_id,
"reusable_form_id": reusable_form_id, "title": title,
"subject": subject, "message": message,
"signing_redirect_url": signing_redirect_url}
# remove attributes with empty value
payload = dict((key, value)
for key, value in payload.iteritems() if value)
request = HSRequest(self.auth)
url = self.SIGNATURE_REQUEST_CREATE_WITH_RF_URL
if client_id:
url = self.SIGNATURE_REQUEST_CREATE_EMBEDDED_WITH_RF_URL
response = request.post(
url, data=dict(
payload.items() + signers_payload.items() +
ccs_payload.items() + custom_fields_payload.items()))
return SignatureRequest(response["signature_request"])
def test_not_found(self):
request = HSRequest(self.client.auth)
try:
request.get(url=HSClient.API_URL + "/not/found")
except NotFound:
pass
def test_not_authorized(self):
request = HSRequest(HTTPBasicAuth("test", ''))
try:
request.get(HSClient.ACCOUNT_INFO_URL)
except Unauthorized:
pass
