Python Migration Guide

1
# Initialize using email and password
2
client = HSClient(email_address="api_user@example.com", password="your_password")
3
4
# Initialize using api key
5
client = HSClient(api_key="YOUR_API_KEY")
6
7
# Initialize using api token
8
client = HSClient(access_token="YOUR_ACCESS_TOKEN")

1
hs_client.send_signature_request_embedded(
2
    test_mode=True,
3
    client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a",
4
    title="NDA with Acme Co.",
5
    subject="The NDA we talked about",
6
    message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
7
    signers=[
8
        { "email_address": "jack@example.com", "name": "Jack", "order": 0 },
9
        { "email_address": "jill@example.com", "name": "Jill", "order": 1 }
10
    ],
11
    cc_email_addresses=["lawyer@dropboxsign.com", "lawyer@example.com"],
12
    files=["NDA.pdf", "ApendixA.pdf"]
13
)

1
signer_1 = models.SubSignatureRequestSigner(
2
    email_address="jack@example.com",
3
    name="Jack",
4
    order=0,
5
)
6
7
attachment_1 = models.SubAttachment(
8
    name="Attachment 1",
9
    instructions="Please download this file",
10
    signer_index=0,
11
    required=True
12
)

1
hs_client.send_signature_request(
2
    test_mode=True,
3
    files=["NDA.pdf", "AppendixA.pdf"],
4
    title="NDA with Acme Co.",
5
    subject="The NDA we talked about",
6
    message="Please sign this NDA and then we can discuss more.",
7
    signers=[
8
        {
9
            "email_address": "jill@example.com",
10
            "name": "Jill",
11
            "order": 1
12
        }
13
    ],
14
    form_fields_per_document=[
15
        [
16
            {
17
                "api_id": "abcd",
18
                "name": "signer_signature",
19
                "type": "signature",
20
                "x": 200,
21
                "y": 300,
22
                "page": 1,
23
                "width": 280,
24
                "height": 72,
25
                "required": True,
26
                "signer": 0
27
            }
28
        ]
29
    ]
30
)

1
form_fields_per_document_signature = models.SubFormFieldsPerDocumentSignature(
2
    type="signature",
3
    document_index=0,
4
    api_id="4688957689",
5
    name="signature1",
6
    x=5,
7
    y=7,
8
    width=60,
9
    height=30,
10
    required=True,
11
    signer=0,
12
    page=1
13
)

1
{
2
  "signers": {
3
    "Client": {
4
      "name": "George",
5
      "email_address": "george@example.com"
6
    },
7
    "Manager": {
8
      "name": "Bob",
9
      "email_address": "bob@example.com"
10
    }
11
  }
12
}

1
from pprint import pprint
2
3
from dropbox_sign import \
4
    ApiClient, ApiException, Configuration, apis, models
5
6
configuration = Configuration(
7
    username="YOUR_API_KEY",
8
)
9
10
with ApiClient(configuration) as api_client:
11
    signature_request_api = apis.SignatureRequestApi(api_client)
12
13
    data = models.SignatureRequestSendWithTemplateRequest.init({
14
        "template_ids": ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"],
15
        "subject": "Purchase Order",
16
        "message": "Glad we could come to an agreement.",
17
        "signers": [
18
            {
19
              "role": "Client",
20
              "name": "George",
21
              "email_address": "george@example.com"
22
            },
23
            {
24
              "role": "Manager",
25
              "name": "Bob",
26
              "email_address": "bob@example.com"
27
            }
28
        ],
29
    })
30
31
    try:
32
        response = signature_request_api.signature_request_send_with_template(data)
33
        pprint(response)
34
    except ApiException as e:
35
        print("Exception when calling Dropbox Sign API: %s\n" % e)

1
{
2
  "ccs": {
3
    "Client": "george@example.com",
4
    "Manager": "bob@example.com"
5
  }
6
}

1
from pprint import pprint
2
3
from dropbox_sign import \
4
    ApiClient, ApiException, Configuration, apis, models
5
6
configuration = Configuration(
7
    username="YOUR_API_KEY",
8
)
9
10
with ApiClient(configuration) as api_client:
11
    signature_request_api = apis.SignatureRequestApi(api_client)
12
13
    data = models.SignatureRequestSendWithTemplateRequest.init({
14
        "template_ids": ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"],
15
        "subject": "Purchase Order",
16
        "message": "Glad we could come to an agreement.",
17
        "signers": [
18
            {
19
              "role": "Client",
20
              "name": "George",
21
              "email_address": "george@example.com"
22
            },
23
            {
24
              "role": "Manager",
25
              "name": "Bob",
26
              "email_address": "bob@example.com"
27
            }
28
        ],
29
        "ccs": [
30
            {
31
                "role": "Client",
32
                "email_address": "george@example.com"
33
            },
34
            {
35
                "role": "Manager",
36
                "email_address": "bob@example.com"
37
            }
38
        ]
39
    })
40
41
    try:
42
        response = signature_request_api.signature_request_send_with_template(data)
43
        pprint(response)
44
    except ApiException as e:
45
        print("Exception when calling Dropbox Sign API: %s\n" % e)

1
{
2
  "custom_fields": {
3
    "company": {
4
      "value": "ABC Corp",
5
      "required": true
6
    }
7
  }
8
}

1
from pprint import pprint
2
3
from dropbox_sign import \
4
    ApiClient, ApiException, Configuration, apis, models
5
6
configuration = Configuration(
7
    username="YOUR_API_KEY",
8
)
9
10
with ApiClient(configuration) as api_client:
11
    signature_request_api = apis.SignatureRequestApi(api_client)
12
13
    data = models.SignatureRequestSendWithTemplateRequest.init({
14
        "template_ids": ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"],
15
        "subject": "Purchase Order",
16
        "message": "Glad we could come to an agreement.",
17
        "signers": [
18
            {
19
              "role": "Client",
20
              "name": "George",
21
              "email_address": "george@example.com"
22
            },
23
            {
24
              "role": "Manager",
25
              "name": "Bob",
26
              "email_address": "bob@example.com"
27
            }
28
        ],
29
        "custom_fields": [
30
            {
31
                "name": "company",
32
                "value": "ABC Corp",
33
                "required": True
34
            },
35
        ]
36
    })
37
38
    try:
39
        response = signature_request_api.signature_request_send_with_template(data)
40
        pprint(response)
41
    except ApiException as e:
42
        print("Exception when calling Dropbox Sign API: %s\n" % e)

1
hs_client = HSClient(api_key="YOUR_API_KEY")
2
hs_client.get_signature_request_file(
3
    signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967",
4
    filename="files.pdf",
5
    file_type="pdf"
6
)

1
hs_client = HSClient(api_key="SIGN_IN_AND_CREATE_API_KEY_FIRST")
2
hs_client.get_template_files("5de8179668f2033afac48da1868d0093bf133266", "download.pdf")

1
hs_client = HSClient(api_key="your_api_key")
2
account = hs_client.get_account_info()
3
4
print hs_client.account.email_address

1
// unavailable in legacy SDK

1
hs_client = HSClient(api_key="api_key")
2
hs_client.get_api_app_info(
3
    client_id="client_id"
4
)

1
// Feature unavailable in legacy SDK

1
hs_client.get_embedded_object("50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b")

1
embeddedObj = hs_client.get_template_edit_url("5de8179668f2033afac48da1868d0093bf133266")
2
edit_url = embeddedObj.edit_url

1
hs_client.get_signature_request("fa5c8a0b0f492d768749333ad6fcc214c111e967")

1
hs_client.get_signature_request_list(
2
  page=1,
3
  page_size= 30
4
)

1
hs_client.cancel_signature_request("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f")

1
hs_client.send_signature_request(
2
    test_mode=True,
3
    title="NDA with Acme Co.",
4
    subject="The NDA we talked about",
5
    message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
6
    signers=[
7
        { "email_address": "jack@example.com", "name": "Jack", "order": 0 },
8
        { "email_address": "jill@example.com", "name": "Jill", "order": 1 }
9
    ],
10
    cc_email_addresses=["lawyer@dropboxsign.com", "lawyer@example.com"],
11
    files=["NDA.pdf", "AppendixA.pdf"],
12
    metadata={
13
        "client_id" : "1234",
14
        "custom_text" : "NDA #9"
15
    }
16
)

1
hs_client.send_signature_request_with_template(
2
    test_mode=True,
3
    template_id="c26b8a16784a872da37ea946b9ddec7c1e11dff6",
4
    subject="Purchase Order",
5
    message="Glad we could come to an agreement.",
6
    signers=[{ "role_name": "Client", "name": "George", "email_address": "george@example.com" }],
7
    ccs=[{ "role_name": "Accounting", "email_address": "accounting@dropboxsign.com" }],
8
    custom_fields=[{ "Cost": "$20,000" }]
9
)

1
hs_client.send_signature_request_embedded(
2
    test_mode=True,
3
    client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a",
4
    title="NDA with Acme Co.",
5
    subject="The NDA we talked about",
6
    message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
7
    signers=[
8
        { "email_address": "jack@example.com", "name": "Jack", "order": 0 },
9
        { "email_address": "jill@example.com", "name": "Jill", "order": 1 }
10
    ],
11
    cc_email_addresses=["lawyer@dropboxsign.com", "lawyer@example.com"],
12
    files=["NDA.pdf", "AppendixA.pdf"]
13
)

1
hs_client.send_signature_request_embedded_with_template(
2
    test_mode=True,
3
    client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a",
4
    template_id="c26b8a16784a872da37ea946b9ddec7c1e11dff6",
5
    title="NDA with Acme Co.",
6
    subject="The NDA we talked about",
7
    message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
8
    signers=[
9
        { "role_name": "Client", "email_address": "jack@example.com", "name": "Jack", "order": 0 },
10
        { "role_name": "Client", "email_address": "jill@example.com", "name": "Jill", "order": 1 }
11
    ],
12
    ccs=[{ "role_name": "Accounting", "email_address": "lawyer@dropboxsign.com" }],
13
    custom_fields=[{ "Cost": "$20,000" }]
14
)

1
hs_client.remind_signature_request(
2
    signature_request_id="2f9781e1a8e2045224d808c153c2e1d3df6f8f2f",
3
    email_address="john@example.com"
4
)

1
hs_client.remove_signature_request_access("signature_request_id")

1
hs_client.update_signature_request(
2
    signature_request_id="signature_request_id",
3
    signature_id="signature_id",
4
    email_address="new_email_address@example.com"
5
)

1
client.get_team_info()

1
hs_client.get_template("f57db65d3f933b5316d398057a36176831451a35")

1
hs_client.get_template_list(page=1)

1
files = ["/docs/nda.pdf"]
2
signer_roles = [
3
    {"name": "Baltar", "order": 1},
4
    {"name": "Madame President", "order": 2},
5
    {"name": "Lee Adama", "order": 3},
6
]
7
cc_roles = ["Deck Chief", "Admiral","Starbuck"]
8
merge_fields = [{"name":"mymerge", "type":"text"}]
9
10
template_draft = hs_client.create_embedded_template_draft(
11
    client_id="26916815c3fbd2622de90ce9b0b115cc",
12
    signer_roles=signer_roles,
13
    test_mode=True,
14
    files=files,
15
    title="Battlestar Test Draft",
16
    subject="There are cylons onboard",
17
    message="Halp",
18
    cc_roles=cc_roles,
19
    merge_fields=merge_fields
20
)
21
22
template_id = template_draft.template_id

1
hs_client.get_template_files("5de8179668f2033afac48da1868d0093bf133266", "download.pdf")

1
hs_client.create_embedded_unclaimed_draft(
2
    test_mode=True,
3
    client_id="ca1209bc08912a8a881234def21352ab",
4
    draft_type="signature_request",
5
    requester_email_address="jack@dropboxsign.com",
6
    is_for_embedded_signing=True,
7
    subject="The NDA we talked about",
8
    files=["NDA.pdf"]
9
)

1
signers = [{
2
    "name": "Signer Name",
3
    "email_address": "signer@example.com",
4
    "role_name": "Signer"
5
}]
6
metadata = {
7
    "account_id": "123",
8
    "company_name": "Acme Co."
9
}
10
11
templateDraft = hs_client.create_embedded_unclaimed_draft_with_template(
12
    test_mode=True,
13
    client_id="26916815c3fbd2622de90ce9b0b115cc",
14
    is_for_embedded_signing=True,
15
    template_id="d3a772a6955a8f97f6b1d4f127a2f485d5546299",
16
    requester_email_address="user@example.com",
17
    title="MyDraft",
18
    subject="Unclaimed Draft Email Subject",
19
    message="Email Message",
20
    signers=signers,
21
    signing_redirect_url="http://url.com",
22
    requesting_redirect_url="http://url.com",
23
    metadata=metadata
24
)
25
url = templateDraft.claim_url