Modules@robinpath/pandadoc
pandadoc

@robinpath/pandadoc

0.1.2Node.jsPublic

PandaDoc module for RobinPath.

PandaDoc

PandaDoc module for RobinPath.

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

Authentication

pandadoc.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 pandadoc module when you need to:

  • listDocuments -- Use pandadoc.listDocuments to perform this operation
  • getDocument -- Use pandadoc.getDocument to perform this operation
  • createDocument -- Use pandadoc.createDocument to perform this operation
  • createDocumentFromTemplate -- Use pandadoc.createDocumentFromTemplate to perform this operation
  • sendDocument -- Use pandadoc.sendDocument to perform this operation

Quick Reference

FunctionDescriptionReturns
setCredentialsConfigure pandadoc credentials.object
listDocumentslistDocumentsobject
getDocumentgetDocumentobject
createDocumentcreateDocumentobject
createDocumentFromTemplatecreateDocumentFromTemplateobject
sendDocumentsendDocumentobject
getDocumentStatusgetDocumentStatusobject
downloadDocumentdownloadDocumentobject
deleteDocumentdeleteDocumentobject
listTemplateslistTemplatesobject
getTemplategetTemplateobject
listContactslistContactsobject
createContactcreateContactobject
getDocumentDetailsgetDocumentDetailsobject
listLinkedObjectslistLinkedObjectsobject

Functions

setCredentials

Configure pandadoc credentials.

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

pandadoc.setCredentials
ParameterTypeRequiredDescription
apiKeystringYesapiKey

listDocuments

listDocuments

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

pandadoc.listDocuments
ParameterTypeRequiredDescription
inputstringNoInput parameter

getDocument

getDocument

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

pandadoc.getDocument
ParameterTypeRequiredDescription
inputstringNoInput parameter

createDocument

createDocument

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

pandadoc.createDocument
ParameterTypeRequiredDescription
inputstringNoInput parameter

createDocumentFromTemplate

createDocumentFromTemplate

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

pandadoc.createDocumentFromTemplate
ParameterTypeRequiredDescription
inputstringNoInput parameter

sendDocument

sendDocument

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

pandadoc.sendDocument
ParameterTypeRequiredDescription
inputstringNoInput parameter

getDocumentStatus

getDocumentStatus

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

pandadoc.getDocumentStatus
ParameterTypeRequiredDescription
inputstringNoInput parameter

downloadDocument

downloadDocument

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

pandadoc.downloadDocument
ParameterTypeRequiredDescription
inputstringNoInput parameter

deleteDocument

deleteDocument

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

pandadoc.deleteDocument
ParameterTypeRequiredDescription
inputstringNoInput parameter

listTemplates

listTemplates

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

pandadoc.listTemplates
ParameterTypeRequiredDescription
inputstringNoInput parameter

getTemplate

getTemplate

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

pandadoc.getTemplate
ParameterTypeRequiredDescription
inputstringNoInput parameter

listContacts

listContacts

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

pandadoc.listContacts
ParameterTypeRequiredDescription
inputstringNoInput parameter

createContact

createContact

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

pandadoc.createContact
ParameterTypeRequiredDescription
inputstringNoInput parameter

getDocumentDetails

getDocumentDetails

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

pandadoc.getDocumentDetails
ParameterTypeRequiredDescription
inputstringNoInput parameter

listLinkedObjects

listLinkedObjects

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

pandadoc.listLinkedObjects
ParameterTypeRequiredDescription
inputstringNoInput parameter

Error Handling

All functions throw on failure. Common errors:

ErrorCause
Pandadoc API error (${res.status}): ${t}Check the error message for details
pandadoc.setCredentials requires apiKey.Check the error message for details
pandadoc.deleteDocument requires an ID.Check the error message for details
Pandadoc: "..." not configured. Call pandadoc.setCredentials first.Check the error message for details
@desc "List documents and validate result"
do
  set $result as pandadoc.listDocuments
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Documents

Retrieve all items and loop through them.

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

@desc "List documents and iterate results"
do
  set $result as pandadoc.listDocuments
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createDocument

Create a new resource and capture the result.

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

@desc "Create document"
do
  set $result as pandadoc.createDocument
  print "Created: " + $result
enddo

3. Check before creating

List existing items and only create if needed.

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

@desc "List documents and create document"
do
  set $existing as pandadoc.listDocuments
  if $existing == null
    pandadoc.createDocument
    print "Item created"
  else
    print "Item already exists"
  end
enddo

4. Multi-step PandaDoc workflow

Chain multiple pandadoc operations together.

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

@desc "List documents, get document, and more"
do
  set $r_listDocuments as pandadoc.listDocuments
  set $r_getDocument as pandadoc.getDocument
  set $r_createDocument as pandadoc.createDocument
  print "All operations complete"
enddo

5. Safe listDocuments with validation

Check results before proceeding.

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

@desc "List documents and validate result"
do
  set $result as pandadoc.listDocuments
  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
  • docusign -- DocuSign module for complementary functionality
  • hellosign -- HelloSign module for complementary functionality

Versions (1)

VersionTagPublished
0.1.2latest1 months ago
Install
$ robinpath add @robinpath/pandadoc

Collaborators

Dumitru Balaban
Dumitru Balaban
@dumitru
View all @robinpath modules
Version0.1.2
LicenseMIT
Unpacked Size4.4 KB
Versions1
Weekly Downloads21
Total Downloads21
Stars0
Last Publish1 months ago
Created1 months ago

Category

productivity