Dotnet Migration Guide

1
using HelloSign;

1
var client = new Client(apiKey);
2
3
// Include OAuth token if using OAuth
4
// client.UseOAuth2Authentication("OAUTH ACCESS TOKEN HERE");
5
6
// Use one the Client class methods to execute a call to an endpoint
7
var account = client.GetAccount("ACCOUNT_CLIENT_ID);
8
Console.Writeline(account.AccountId)

1
var client = new Client(apiKey);
2
// Set invalid email address to cause error
3
string emailAddress = "dropbox.com";
4
try
5
{
6
    var account = client.VerifyAccount(emailAddress);
7
    Console.WriteLine(account);
8
}
9
// Use the ErrorException class to display error name and message
10
catch(HelloSign.ErrorException e)
11
{
12
    Console.WriteLine("Status Code: " + e.ErrorName);
13
    Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
14
}

1
// Client setup
2
var client = new Client(apiKey);
3
var request = new SignatureRequest();
4
request.Subject = "The NDA we talked about";
5
request.Message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions.";
6
request.Title = "NDA with Acme Co.";
7
request.AddSigner("jack@dropboxsign.com", "Jack");
8
request.AddSigner("jill@dropboxsign.com", "Jill");
9
request.AddFile("c:\users\me\My Documents\nda.txt");
10
// Adjusted parameters so that form field is out of bounds of the document to cause warning
11
FormField formField1 = new FormField("uniqueIeHere_1", "signature", 1, 45, 985, 270, 40, true, 0, null, null, null);
12
request.AddFormField(formField1);
13
FormField formField2 = new FormField("uniqueIdHere_2", "signature", 1, 16, 100, 112, 40, true, 1, null, null, null);
14
request.AddFormField(formField2);
15
request.TestMode = true;
16
// Send request
17
var response = client.SendSignatureRequest(request, clientId);
18
Console.WriteLine("New Embedded Signature Request ID: " + response.SignatureRequestId);
19
requestId = response.SignatureRequestId;
20
int num = 1;
21
// Loop through warnings in the Client instance
22
foreach (var warning in client.Warnings)
23
{
24
    Console.WriteLine($"{num}: {warning.WarningName} - {warning.WarningMsg}");
25
    num++;
26
}

1
var signer1 = new SubSignatureRequestSigner(
2
    emailAddress: "jack@example.com",
3
    name: "Jack",
4
    order: 0
5
);
6
7
var attachment1 = new SubAttachment(
8
    name: "Attachment 1",
9
    instructions: "Please download this file",
10
    signerIndex: 0
11
);
12
attachment1.Required = true;

1
var request = new SignatureRequest();
2
request.Title = "NDA with Acme Co.";
3
request.Subject = "The NDA we talked about";
4
request.Message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions.";
5
request.AddSigner("jack@example.com", "Jack");
6
request.AddSigner("jill@example.com", "Jill");
7
request.AddFile("https://app.hellosign.com/docs/example_signature_request.pdf").WithFields(
8
//                  id         type             page   x   y    w   h   req  signer
9
    new FormField("sig1", FormField.TypeSignature, 1, 140, 72, 225, 52, true, 0),
10
    new FormField("sig2", FormField.TypeSignature, 1, 140, 144, 225, 52, true, 1)
11
);
12
request.TestMode = true;
13
var response = client.CreateEmbeddedSignatureRequest(request, clientId);

1
var formField1Dict = new Dictionary<string, object>()
2
{
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
};
14
15
var formField1 = SubFormFieldsPerDocumentSignature.Init(
16
    JsonConvert.SerializeObject(formField1Dict)
17
);

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
using Dropbox.Sign.Api;
2
using Dropbox.Sign.Client;
3
using Dropbox.Sign.Model;
4
using Newtonsoft.Json;
5
6
public class Example
7
{
8
    public static void Main()
9
    {
10
        var config = new Configuration();
11
        config.Username = "YOUR_API_KEY";
12
13
        var signatureRequestApi = new SignatureRequestApi(config);
14
15
        var signer1Dict = new Dictionary<string, object>()
16
        {
17
            ["role"] = "Client",
18
            ["name"] = "George",
19
            ["email_address"] = "george@example.com",
20
        };
21
22
        var signer1 = SubSignatureRequestTemplateSigner.Init(
23
            JsonConvert.SerializeObject(signer1Dict)
24
        );
25
26
        var signer2Dict = new Dictionary<string, object>()
27
        {
28
            ["role"] = "Manager",
29
            ["name"] = "Bob",
30
            ["email_address"] = "bob@example.com",
31
        };
32
33
        var signer2 = SubSignatureRequestTemplateSigner.Init(
34
            JsonConvert.SerializeObject(signer2Dict)
35
        );
36
37
        var data = new SignatureRequestSendWithTemplateRequest(
38
            templateIds: new List<string>(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"},
39
            subject: "Purchase Order",
40
            message: "Glad we could come to an agreement.",
41
            signers: new List<SubSignatureRequestTemplateSigner>(){signer1, signer2}
42
        );
43
44
        try
45
        {
46
            var result = signatureRequestApi.SignatureRequestSendWithTemplate(data);
47
            Console.WriteLine(result);
48
        }
49
        catch (ApiException e)
50
        {
51
            Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
52
            Console.WriteLine("Status Code: " + e.ErrorCode);
53
            Console.WriteLine(e.StackTrace);
54
        }
55
    }
56
}

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

1
using Dropbox.Sign.Api;
2
using Dropbox.Sign.Client;
3
using Dropbox.Sign.Model;
4
using Newtonsoft.Json;
5
6
public class Example
7
{
8
    public static void Main()
9
    {
10
        var config = new Configuration();
11
        config.Username = "YOUR_API_KEY";
12
13
        var signatureRequestApi = new SignatureRequestApi(config);
14
15
        var signer1Dict = new Dictionary<string, object>()
16
        {
17
            ["role"] = "Client",
18
            ["name"] = "George",
19
            ["email_address"] = "george@example.com",
20
        };
21
22
        var signer1 = SubSignatureRequestTemplateSigner.Init(
23
            JsonConvert.SerializeObject(signer1Dict)
24
        );
25
26
        var signer2Dict = new Dictionary<string, object>()
27
        {
28
            ["role"] = "Manager",
29
            ["name"] = "Bob",
30
            ["email_address"] = "bob@example.com",
31
        };
32
33
        var signer2 = SubSignatureRequestTemplateSigner.Init(
34
            JsonConvert.SerializeObject(signer2Dict)
35
        );
36
37
        var cc1Dict = new Dictionary<string, object>()
38
        {
39
            ["role"] = "Client",
40
            ["email_address"] = "george@example.com",
41
        };
42
43
        var cc1 = SubCC.Init(
44
            JsonConvert.SerializeObject(cc1Dict)
45
        );
46
47
        var cc2Dict = new Dictionary<string, object>()
48
        {
49
            ["role"] = "Manager",
50
            ["email_address"] = "bob@example.com",
51
        };
52
53
        var cc2 = SubCC.Init(
54
            JsonConvert.SerializeObject(cc2Dict)
55
        );
56
57
        var data = new SignatureRequestSendWithTemplateRequest(
58
            templateIds: new List<string>(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"},
59
            subject: "Purchase Order",
60
            message: "Glad we could come to an agreement.",
61
            signers: new List<SubSignatureRequestTemplateSigner>(){signer1, signer2},
62
            ccs: new List<SubCC>(){cc1, cc2}
63
        );
64
65
        try
66
        {
67
            var result = signatureRequestApi.SignatureRequestSendWithTemplate(data);
68
            Console.WriteLine(result);
69
        }
70
        catch (ApiException e)
71
        {
72
            Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
73
            Console.WriteLine("Status Code: " + e.ErrorCode);
74
            Console.WriteLine(e.StackTrace);
75
        }
76
    }
77
}

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

1
using Dropbox.Sign.Api;
2
using Dropbox.Sign.Client;
3
using Dropbox.Sign.Model;
4
using Newtonsoft.Json;
5
6
public class Example
7
{
8
    public static void Main()
9
    {
10
        var config = new Configuration();
11
        config.Username = "YOUR_API_KEY";
12
13
        var signatureRequestApi = new SignatureRequestApi(config);
14
15
        var signer1Dict = new Dictionary<string, object>()
16
        {
17
            ["role"] = "Client",
18
            ["name"] = "George",
19
            ["email_address"] = "george@example.com",
20
        };
21
22
        var signer1 = SubSignatureRequestTemplateSigner.Init(
23
            JsonConvert.SerializeObject(signer1Dict)
24
        );
25
26
        var signer2Dict = new Dictionary<string, object>()
27
        {
28
            ["role"] = "Manager",
29
            ["name"] = "Bob",
30
            ["email_address"] = "bob@example.com",
31
        };
32
33
        var signer2 = SubSignatureRequestTemplateSigner.Init(
34
            JsonConvert.SerializeObject(signer2Dict)
35
        );
36
37
        var customField1Dict = new Dictionary<string, object>()
38
        {
39
            ["name"] = "company",
40
            ["value"] = "ABC Corp",
41
            ["required"] = true,
42
        };
43
44
        var customField1 = SubCustomField.Init(
45
            JsonConvert.SerializeObject(customField1Dict)
46
        );
47
48
        var data = new SignatureRequestSendWithTemplateRequest(
49
            templateIds: new List<string>(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"},
50
            subject: "Purchase Order",
51
            message: "Glad we could come to an agreement.",
52
            signers: new List<SubSignatureRequestTemplateSigner>(){signer1, signer2},
53
            customFields: new List<SubCustomField>(){customField1}
54
        );
55
56
        try
57
        {
58
            var result = signatureRequestApi.SignatureRequestSendWithTemplate(data);
59
            Console.WriteLine(result);
60
        }
61
        catch (ApiException e)
62
        {
63
            Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
64
            Console.WriteLine("Status Code: " + e.ErrorCode);
65
            Console.WriteLine(e.StackTrace);
66
        }
67
    }
68
}

1
var request = new SignatureRequest();
2
request.Title = "NDA with Acme Co.";
3
request.Subject = "The NDA we talked about";
4
request.Message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions.";
5
request.AddSigner("jack@example.com", "Jack");
6
request.AddFile("c:\users\me\My Documents\nda.pdf");
7
request.TestMode = true;
8
var response = client.SendSignatureRequest(request);
9
Console.WriteLine("New Signature Request ID: " + response.SignatureRequestId);

1
// 1. Download a merged PDF
2
var bytes = client.DownloadSignatureRequestFiles("SIGNATURE REQUEST ID HERE");
3
// 2. Download a ZIP containing individual unmerged PDFs
4
var bytes = client.DownloadSignatureRequestFiles(
5
    "SIGNATURE REQUEST ID HERE",
6
    SignatureRequest.FileType.ZIP
7
);

1
// 1. Download a merged PDF
2
var bytes = client.DownloadTemplateFiles("TEMPLATE ID HERE");
3
// 2. Download a ZIP containing individual unmerged PDFs
4
var bytes = client.DownloadTemplateFiles(
5
    "TEMPLATE ID HERE",
6
    SignatureRequest.FileType.ZIP
7
);

1
// The Legacy SDK did not support the Update API App endpoint, but here is an example of how oauth and white labeling options were passed in the Create Api App endpoint
2
// Inject white_labeling_options into AdditionalParameters
3
client.AdditionalParameters.Add("white_labeling_options", "{ \"header_background_color\":\"#1A1A1A\", \"page_background_color\": \"#F7F8F9\", \"legal_version\":\"terms2\"}");
4
// Create an instance of Oauth and set the new Oauth callback URL and scopes
5
var oauth = new Oauth()
6
{
7
    CallbackUrl = "https://example.com/oauth",
8
    Scopes = new List<string>()
9
    {
10
        "basic_account_info",
11
        "request_signature"
12
    }
13
};
14
// Create new instance of ApiApp
15
var apiAppApi = new ApiApp();
16
apiAppApi.Name = "Test App 1";
17
apiAppApi.Domain = "test1.com";
18
apiAppApi.Oauth = oauth;
19
apiAppApi.CallbackUrl = "https://example.com/";
20
// Send request
21
var response = client.CreateApiApp(apiAppApi);
22
Console.WriteLine(response.ClientId);

1
// Create new instance of TemplateSignatureRequest
2
var request = new TemplateSignatureRequest();
3
request.AddTemplate("1cba0c693fe6fc2bdd3b9967f704740e7631696c");
4
request.Title = "Rental Agreement";
5
request.Subject = "Contract for new apartment";
6
request.Message = "Please sign this Rental Agreement.";
7
request.AddSigner("Client 1", "jack@dropboxsign.com", "Jack");
8
// Add custom field
9
request.AddCustomField("Address", "123 Dropbox Drive", "Client 1", true);
10
request.TestMode = true;
11
// Send request
12
var response = client.SendSignatureRequest(request);
13
Console.WriteLine("New Signature Request ID: " + response.SignatureRequestId);

1
var request = new SignatureRequest();
2
request.Title = "NDA with Acme Co.";
3
request.Subject = "The NDA we talked about";
4
request.Message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions.";
5
request.AddSigner("jack@example.com", "Jack");
6
request.AddSigner("jill@example.com", "Jill");
7
request.AddFile("https://app.hellosign.com/docs/example_signature_request.pdf").WithFields(
8
//                  id         type             page   x   y    w   h   req  signer
9
    new FormField("sig1", FormField.TypeSignature, 1, 140, 72, 225, 52, true, 0),
10
    new FormField("sig2", FormField.TypeSignature, 1, 140, 144, 225, 52, true, 1)
11
);
12
request.TestMode = true;
13
var response = client.CreateEmbeddedSignatureRequest(request, clientId);

1
var client = new Client(apiKey);
2
// Inject additional parameters for account_id and query
3
client.AdditionalParameters.Add("account_id", "all");
4
client.AdditionalParameters.Add("query", "complete:true");
5
var queryList = client.ListSignatureRequests(0, 100);
6
// Remove injected parameters before next request
7
client.AdditionalParameters.Remove("account_id");
8
client.AdditionalParameters.Remove("query");
9
Console.WriteLine("Found this many signature requests: " + allRequests.NumResults);
10
foreach (var result in queryList)
11
{
12
    Console.WriteLine("Signature request: " + result.SignatureRequestId);
13
    if (result.IsComplete) == true) { Console.WriteLine("Signature request is complete.");}
14
    else { Console.WriteLine("Signature request is not complete");}
15
}

1
var draft = new EmbeddedTemplateDraft();
2
draft.TestMode = true;
3
draft.AddFile(file1, "NDA.txt");
4
draft.Title = "Test Template";
5
draft.Subject = "Please sign this document";
6
draft.Message = "For your approval.";
7
draft.AddSignerRole("Client", 0);
8
draft.AddSignerRole("Witness", 1);
9
draft.AddCcRole("Manager");
10
draft.AddMergeField("Full Name", MergeField.FieldType.Text);
11
draft.AddMergeField("Is Registered?", MergeField.FieldType.Checkbox);
12
var response = client.CreateEmbeddedTemplateDraft(draft, "CLIENT ID HERE");

1
var request = new SignatureRequest();
2
request.Title = "NDA with Acme Co.";
3
request.Subject = "The NDA we talked about";
4
request.Message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions.";
5
request.AddSigner("jack@example.com", "Jack");
6
request.AddSigner("jill@example.com", "Jill");
7
request.AddFile("c:\users\me\My Documents\example_signature_request.pdf");;
8
request.Metadata.Add("custom_id", "1234");
9
request.Metadata.Add("custom_text", "NDA #9");
10
request.TestMode = true;
11
var response = client.CreateEmbeddedSignatureRequest(request, "CLIENT ID HERE");
12
Console.WriteLine("New Embedded Signature Request ID: " + response.SignatureRequestId);

1
var response = client.GetSignUrl("SIGNATURE ID HERE");
2
Console.WriteLine("Signature URL for HelloSign.open(): " + response.SignUrl);

1
var draft = new SignatureRequest();
2
draft.AddFile("DOCUMENT A.pdf");
3
draft.RequesterEmailAddress = "EMAIL HERE";
4
draft.TestMode = true;
5
var response = client.CreateUnclaimedDraft(draft, myClientId);
6
Console.WriteLine("Embedded Unclaimed Draft Signature Request ID: " + response.SignatureRequestId);
7
Console.WriteLine("Claim URL: " + response.ClaimUrl);