DocuSign

DocuSign module for RobinPath.

Package: @robinpath/docusign | Category: Documents | Type: Integration

Authentication

docusign.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the docusign module when you need to:

• listEnvelopes -- Use docusign.listEnvelopes to perform this operation
• getEnvelope -- Use docusign.getEnvelope to perform this operation
• createEnvelope -- Use docusign.createEnvelope to perform this operation
• sendEnvelope -- Use docusign.sendEnvelope to perform this operation
• voidEnvelope -- Use docusign.voidEnvelope to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure docusign credentials.	object
listEnvelopes	listEnvelopes	object
getEnvelope	getEnvelope	object
createEnvelope	createEnvelope	object
sendEnvelope	sendEnvelope	object
voidEnvelope	voidEnvelope	object
getEnvelopeDocuments	getEnvelopeDocuments	object
downloadDocument	downloadDocument	object
listRecipients	listRecipients	object
getRecipientStatus	getRecipientStatus	object
listTemplates	listTemplates	object
getTemplate	getTemplate	object
createEnvelopeFromTemplate	createEnvelopeFromTemplate	object
getUserInfo	getUserInfo	object
getAccount	getAccount	object

Functions

setCredentials

Configure docusign credentials.

Module: docusign | Returns: object -- API response.

docusign.setCredentials

Parameter	Type	Required	Description
accessToken	string	Yes	accessToken
accountId	string	Yes	accountId

---

listEnvelopes

listEnvelopes

Module: docusign | Returns: object -- API response.

docusign.listEnvelopes

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getEnvelope

getEnvelope

Module: docusign | Returns: object -- API response.

docusign.getEnvelope

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createEnvelope

createEnvelope

Module: docusign | Returns: object -- API response.

docusign.createEnvelope

Parameter	Type	Required	Description
input	string	No	Input parameter

---

sendEnvelope

sendEnvelope

Module: docusign | Returns: object -- API response.

docusign.sendEnvelope

Parameter	Type	Required	Description
input	string	No	Input parameter

---

voidEnvelope

voidEnvelope

Module: docusign | Returns: object -- API response.

docusign.voidEnvelope

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getEnvelopeDocuments

getEnvelopeDocuments

Module: docusign | Returns: object -- API response.

docusign.getEnvelopeDocuments

Parameter	Type	Required	Description
input	string	No	Input parameter

---

downloadDocument

downloadDocument

Module: docusign | Returns: object -- API response.

docusign.downloadDocument

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listRecipients

listRecipients

Module: docusign | Returns: object -- API response.

docusign.listRecipients

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getRecipientStatus

getRecipientStatus

Module: docusign | Returns: object -- API response.

docusign.getRecipientStatus

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listTemplates

listTemplates

Module: docusign | Returns: object -- API response.

docusign.listTemplates

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getTemplate

getTemplate

Module: docusign | Returns: object -- API response.

docusign.getTemplate

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createEnvelopeFromTemplate

createEnvelopeFromTemplate

Module: docusign | Returns: object -- API response.

docusign.createEnvelopeFromTemplate

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getUserInfo

getUserInfo

Module: docusign | Returns: object -- API response.

docusign.getUserInfo

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getAccount

getAccount

Module: docusign | Returns: object -- API response.

docusign.getAccount

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Docusign API error (${res.status}): ${t}	Check the error message for details
docusign.setCredentials requires accessToken, accountId.	Check the error message for details
docusign.voidEnvelope requires an ID.	Check the error message for details
Docusign: "..." not configured. Call docusign.setCredentials first.	Check the error message for details

@desc "List envelopes and validate result"
do
  set $result as docusign.listEnvelopes
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Envelopes

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  docusign.setCredentials $token
enddo

@desc "List envelopes and iterate results"
do
  set $result as docusign.listEnvelopes
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createEnvelope

Create a new resource and capture the result.

@desc "Setup authentication"
do
  docusign.setCredentials $token
enddo

@desc "Create envelope"
do
  set $result as docusign.createEnvelope
  print "Created: " + $result
enddo

3. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  docusign.setCredentials $token
enddo

@desc "List envelopes and create envelope"
do
  set $existing as docusign.listEnvelopes
  if $existing == null
    docusign.createEnvelope
    print "Item created"
  else
    print "Item already exists"
  end
enddo

4. Multi-step DocuSign workflow

Chain multiple docusign operations together.

@desc "Setup authentication"
do
  docusign.setCredentials $token
enddo

@desc "List envelopes, get envelope, and more"
do
  set $r_listEnvelopes as docusign.listEnvelopes
  set $r_getEnvelope as docusign.getEnvelope
  set $r_createEnvelope as docusign.createEnvelope
  print "All operations complete"
enddo

5. Safe listEnvelopes with validation

Check results before proceeding.

@desc "Setup authentication"
do
  docusign.setCredentials $token
enddo

@desc "List envelopes and validate result"
do
  set $result as docusign.listEnvelopes
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• pdf -- PDF module for complementary functionality
• excel -- Excel module for complementary functionality
• office -- Office module for complementary functionality
• pandadoc -- PandaDoc module for complementary functionality
• hellosign -- HelloSign module for complementary functionality