Node Migration Guide

1
const sign_sdk = require('hellosign-sdk')({ key: "API_KEY" });

1
const sign_sdk = require('hellosign-sdk')({key: 'YOUR API KEY HERE'});

1
import * as DropboxSign from "@dropbox/sign";
2
3
const signatureRequestApi = new DropboxSign.SignatureRequestApi();
4
5
signatureRequestApi.username = "YOUR_API_KEY";
6
7
const data = {
8
  emailAddress: "john@example.com"
9
};
10
11
const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f";
12
13
const result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data);
14
result.then(response => {
15
  console.log(response.body);
16
}).catch(error => {
17
  console.log("Exception when calling Dropbox Sign API:");
18
  console.log(error.body);
19
});

1
const signer1 = new DropboxSign.SubSignatureRequestSigner();
2
signer1.name = "George";
3
signer1.emailAddress = "george@example.com";
4
5
const attachment1 = new DropboxSign.SubAttachment();
6
attachment1.name = "Attachment 1";
7
attachment1.instructions = "Please download this file";
8
attachment1.signerIndex = 0;
9
attachment1.required = true;

1
const hellosign = require('hellosign-sdk')({ key: process.env.HelloSign_API_KEY });
2
3
module.exports = {
4
send_signature_request: function () {
5
  const opts = {
6
    test_mode: 1,
7
    files: ['Demo-Mutual-Non-Disclosure-Agreement.pdf'],
8
    title: 'NDA with Acme Co.',
9
    subject: 'The NDA we talked about',
10
    message: 'Please sign this NDA and then we can discuss more.',
11
    signers: [
12
      {
13
        name: 'Jill',
14
        email_address: 'jill@example.com'
15
      }
16
    ],
17
    form_fields_per_document: [[{
18
      "api_id": "abcd",
19
      "name": "signer_signature",
20
      "type": "signature",
21
      "x": 200,
22
      "y": 300,
23
      "page": 1,
24
      "width": 280,
25
      "height": 72,
26
      "required": true,
27
      "signer": 0
28
    }]]
29
};
30
31
  hellosign.signatureRequest.send(opts).then((res) => {
32
      console.log(res)
33
    }).catch((err) => {
34
      console.log(err)
35
    });
36
  }
37
}

1
const data = {
2
  testMode: true,
3
  files: [ yourFile ],
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: [ signer1 ],
8
  formFieldsPerDocument: [
9
    {
10
      type: "signature",
11
      documentIndex: 0,
12
      apiId: "abcd",
13
      name: "field_1",
14
      x: 200,
15
      y: 300,
16
      page: 1,
17
      width: 280,
18
      height: 72,
19
      required: true,
20
      signer: "0"
21
    }
22
  ]
23
};

1
// type is automatically set to "signature"
2
const formField1 = new DropboxSign.SubFormFieldsPerDocumentSignature();
3
formField1.documentIndex = 0;
4
formField1.apiId = "abcd";
5
formField1.name = "signer_signature";
6
formField1.x = 200;
7
formField1.y = 300;
8
formField1.page = 1;
9
formField1.width = 280;
10
formField1.height = 72;
11
formField1.required = true;
12
formField1.signer = "0";
13
14
const data = {
15
  testMode: true,
16
  files: [ yourFile ],
17
  title: "NDA with Acme Co.",
18
  subject: "The NDA we talked about",
19
  message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
20
  signers: [ signer1 ],
21
  formFieldsPerDocument: [ formField1 ]
22
};

1
// TS2741: Property '"type"' is missing in type [...]
2
const formField1: DropboxSign.SubFormFieldsPerDocumentSignature = {
3
  documentIndex: 0,
4
  apiId: "abcd",
5
  name: "field_1",
6
  x: 200,
7
  y: 300,
8
  page: 1,
9
  width: 280,
10
  height: 72,
11
  required: true,
12
  signer: "0"
13
}
14
15
const data = {
16
  testMode: true,
17
  files: [ yourFile ],
18
  title: "NDA with Acme Co.",
19
  subject: "The NDA we talked about",
20
  message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
21
  signers: [ signer1 ],
22
  formFieldsPerDocument: [ formField1 ]
23
};
24
25
const result = signatureApi.signatureRequestSend(data);
26
result.then(response => {
27
  console.log(response.body);
28
}).catch(error => {
29
  console.log("Exception when calling Dropbox Sign API:");
30
  console.log(error.body);
31
});

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
import * as DropboxSign from "@dropbox/sign";
2
3
const signatureRequestApi = new DropboxSign.SignatureRequestApi();
4
5
signatureRequestApi.username = "YOUR_API_KEY";
6
7
const data = {
8
  templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"],
9
  subject: "Purchase Order",
10
  message: "Glad we could come to an agreement.",
11
  signers: [
12
    {
13
      "role": "Client",
14
      "name": "George",
15
      "emailAddress": "george@example.com"
16
    },
17
    {
18
      "role": "Manager",
19
      "name": "Bob",
20
      "emailAddress": "bob@example.com"
21
    }
22
  ]
23
};
24
25
const result = signatureRequestApi.signatureRequestSendWithTemplate(data);
26
result.then(response => {
27
  console.log(response.body);
28
}).catch(error => {
29
  console.log("Exception when calling Dropbox Sign API:");
30
  console.log(error.body);
31
});

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

1
import * as DropboxSign from "@dropbox/sign";
2
3
const signatureRequestApi = new DropboxSign.SignatureRequestApi();
4
5
signatureRequestApi.username = "YOUR_API_KEY";
6
7
const data = {
8
  templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"],
9
  subject: "Purchase Order",
10
  message: "Glad we could come to an agreement.",
11
  signers: [
12
    {
13
      role: "Client",
14
      name: "George",
15
      emailAddress: "george@example.com"
16
    },
17
    {
18
      role: "Manager",
19
      name: "Bob",
20
      emailAddress: "bob@example.com"
21
    }
22
  ],
23
  ccs: [
24
    {
25
      role: "Client",
26
      emailAddress: "george@example.com"
27
    },
28
    {
29
      role: "Manager",
30
      emailAddress: "bob@example.com"
31
    }
32
  ]
33
};
34
35
const result = signatureRequestApi.signatureRequestSendWithTemplate(data);
36
result.then(response => {
37
  console.log(response.body);
38
}).catch(error => {
39
  console.log("Exception when calling Dropbox Sign API:");
40
  console.log(error.body);
41
});

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

1
import * as DropboxSign from "@dropbox/sign";
2
3
const signatureRequestApi = new DropboxSign.SignatureRequestApi();
4
5
signatureRequestApi.username = "YOUR_API_KEY";
6
7
const data = {
8
  templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"],
9
  subject: "Purchase Order",
10
  message: "Glad we could come to an agreement.",
11
  signers: [
12
    {
13
      role: "Client",
14
      name: "George",
15
      emailAddress: "george@example.com"
16
    },
17
    {
18
      role: "Manager",
19
      name: "Bob",
20
      emailAddress: "bob@example.com"
21
    }
22
  ],
23
  customFields: [
24
    {
25
      name: "company",
26
      value: "ABC Corp",
27
      required: true
28
    }
29
  ]
30
};
31
32
const result = signatureRequestApi.signatureRequestSendWithTemplate(data);
33
result.then(response => {
34
  console.log(response.body);
35
}).catch(error => {
36
  console.log("Exception when calling Dropbox Sign API:");
37
  console.log(error.body);
38
});

$
test_mode
$
template_id
$
custom_fields
$
form_fields_per_document
$
signing_options

1
const hellosign = require('hellosign-sdk')({ key: process.env.HelloSign_API_KEY });
2
3
module.exports = {
4
send_signature_request: function () {
5
  const opts = {
6
    test_mode: 1,
7
    files: ['Demo-Mutual-Non-Disclosure-Agreement.pdf'],
8
    title: 'NDA with Acme Co.',
9
    subject: 'The NDA we talked about',
10
    message: 'Please sign this NDA and then we can discuss more.',
11
    signers: [
12
      {
13
        name: 'Jill',
14
        email_address: 'jill@example.com'
15
      }
16
    ]
17
  };
18
19
  hellosign.signatureRequest.send(opts).then((res) => {
20
    console.log(res)
21
  }).catch((err) => {
22
    console.log(err)
23
  });
24
 }
25
}

1
var signature_request_id = 'SIGNATURE_REQUEST_ID'
2
3
hellosign.signatureRequest.download(signature_request_id, {file_type: 'zip'}, function(err, response) {
4
var file = fs.createWriteStream("files.zip");
5
response.pipe(file);
6
  file.on('finish', function() {
7
    file.close();
8
  });
9
});

1
var signature_request_id = 'SIGNATURE_REQUEST_ID'
2
3
hellosign.signatureRequest.download('SIGNATURE_REQUEST_ID', { get_data_uri: true }, (err, res) => {
4
 console.log(res)
5
});

1
var signature_request_id = 'SIGNATURE_REQUEST_ID'
2
3
hellosign.signatureRequest.download('SIGNATURE_REQUEST_ID', { get_url: true }, (err, res) => {
4
 console.log(res)
5
});

1
import * as DropboxSign from "@dropbox/sign";
2
import * as fs from 'fs';
3
4
const templateApi = new DropboxSign.TemplateApi();
5
6
// Configure HTTP basic authorization: api_key
7
templateApi.username = "YOUR_API_KEY";
8
9
// or, configure Bearer authorization: oauth2
10
// templateApi.accessToken = "YOUR_ACCESS_TOKEN";
11
12
const templateId = "5de8179668f2033afac48da1868d0093bf133266";
13
const fileType = "pdf";
14
15
const result = templateApi.templateFiles(templateId, fileType);
16
result.then(response => {
17
  fs.createWriteStream('file_response.pdf').write(response.body);
18
}).catch(error => {
19
  console.log("Exception when calling Dropbox Sign API:");
20
  console.log(error.body);
21
});

1
const hellosign = require('hellosign-sdk')({ key: process.env.HelloSign_API_KEY });
2
3
hellosign.account.get().then((res) => {
4
    console.log(res)
5
}).catch((err) => {
6
    console.log(err)
7
});

1
const hellosign = require('hellosign-sdk')({ key: 'HelloSign_API_KEY' });
2
3
hellosign.signatureRequest.get(SIGNATURE_REQUEST_ID).then((res) => {
4
    console.log(res)
5
}).catch((err) => {
6
    console.log(err)
7
});

1
const hellosign = require('hellosign-sdk')({ key: 'HelloSign_API_KEY' });
2
3
var signers = [
4
  {
5
    email_address : 'jack@example.com',
6
    name : 'Jack',
7
    order : 0,
8
  },
9
  {
10
    email_address : 'jill@example.com',
11
    name : 'Jill',
12
    order : 1,
13
  }
14
]
15
16
var options = {
17
  test_mode : 1,
18
  title : 'NDA with Acme Co.',
19
  subject : 'The NDA we talked about',
20
  message : 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
21
  signers : signers,
22
  cc_email_addresses : ['lawyer@example.com', 'lawyer2@example.com'],
23
  files : ['./Demo-Mutual-Non-Disclosure-Agreement.pdf'],
24
  metadata : {
25
    clientId : '1234',
26
    custom_text : 'NDA #9'
27
  }
28
};
29
30
hellosign.signatureRequest.send(options)
31
.then(function(res){
32
  console.log(res.signature_request);
33
});

1
const hellosign = require('hellosign-sdk')({ key: 'HelloSign_API_KEY' });
2
3
var options = {
4
  test_mode : 1,
5
  clientId : 'CLIENT_ID',
6
  template_id : 'TEMPLATE_ID',
7
  subject : 'Purchase Order',
8
  message : 'Glad we could come to an agreement.',
9
  signers : [
10
    {
11
      role : 'Client',
12
      email_address : 'george@example.com',
13
      name : 'George',
14
    }
15
  ]
16
};
17
18
hellosign.signatureRequest.createEmbeddedWithTemplate(options);
19
.then(function(res){
20
  console.log(res.signature_request);
21
});

1
const opts = {
2
  name: 'My Cool App',
3
  white_labeling_options: '{"primary_button_color":"#ff0000","primary_button_text_color":"#000000"}'
4
};
5
6
hellosign.apiApp.update('CLIENT_ID', opts).then((res) => {
7
  console.log(res)
8
}).catch((err) => {
9
  console.log(err)
10
});