Soukoku.DropboxSignApi 3.0.0-alpha1

DropboxSignApi

This is v3 of an unofficial Dropbox Sign (previously HelloSign) API lib for dotnet 4.6.2+ and core versions. It uses HttpClient to do the API calls and supports the async operations out of the box. This v3 is still a work in progress.

How to get it

This lib is available via the NuGet package Soukoku.DropboxSignApi.

Using the library

All API access is done through an instance of the DropboxSignClient.

// all examples later will make use of this 'client' object
var client = new DropboxSignClient("your apiKey here");

Request models

This library defines tailored models for different requests parameters, so it's easy to see what are the supported properties for each request type.

var sigRequest = new SendSignatureRequestRequest();
// ...
// set various request properties here
// ...
SignatureRequestResponseWrap response = await client.SendSignatureRequestAsync(sigRequest);

Files in requests

For any requests that support file uploads you can use either the FileUrls or Files property. Use them either for remote http files or local files, but not both in a single request.

// remote file
sigRequest.FileUrls.Add(new Uri("http://path-to-remote-file"));

// or local file path
sigRequest.Files.Add(new PendingFile("path\to\local\file", "file name here"));

// or local file bytes
byte[] fileData = ...// some how get file data
sigRequest.Files.Add(new PendingFile(fileData, "file name here"));

// or local file stream
Stream fileData = ...// some how get file stream
sigRequest.Files.Add(new PendingFile(fileData, "file name here"));

Note that for local files, you will be responsible in disposing the request object to clean up the streams. It's best to just wrap the request in a using

using (var sigRequest = new SendSignatureRequestRequest()) {
  // do things with it
}

Response models

All API calls will return the ResponseWrap class and its sub-classes. The ResponseWrap contains all the returned information from the API call, including any error, warnings, and rate-limiting information.

This means that, assuming the parameters are valid and there are no network errors, all API calls will not throw an Exception and you will need to handle the returned response as appropriate based on the error and http status code.

SignatureRequestResponseWrap response = await client.SendSignatureRequestAsync(sigRequest);

// maybe check rate limits
if (response.RateLimitRemaining < 10)
{
    // do something about it
}

// handle result
if (response.Error == null) 
{
    SignatureRequest finalRequest = response.SignatureRequest;
    // do work ...
} 
else 
{
    // handle error
}

Magic string values

Many of the models contain string properties that have pre-defined values. Where applicable, the property doc (intellisense) will indicate where you can find those values. They are usually defined as string constants in a similarly-named static class.

For example, the ErrorNames class contains the possible values for the Error.Name property

// handle error in a response
switch(response.Error.Name)
{
    case ErrorNames.ExceededRate:
        // handle it
        break;
    case ErrorNames.InvalidRecipient:
        // handle it
        break;
    // more cases
}

Event model

This lib can also be used to parse the webhook event callback data:

string jsonData = ...;// somehow get the event callback json content
var wrap = client.ParseEvent(jsonData);
// handle the event
switch(wrap.Event.EventType)
{
    case EventTypes.SignatureRequestSigned:
        // do something
        break;
    case EventTypes.SignatureRequestEmailBounce:
        // do something
        break;
    // more cases
}