@orchestree/documents
v1.3.0
Published
Documents module — E-signature flows, document templates, envelope management, audit trails
Maintainers
orchestree-devReadme
@orchestree/documents
Document management and e-signature services for Orchestree. Create, send, sign, and manage documents with automated workflows.
Installation
npm install @orchestree/documentsQuick Start
const { DocumentsClient } = require('@orchestree/documents');
const client = new DocumentsClient({
apiKey: 'your-api-key',
});
// Create an envelope
const envelope = await client.createEnvelope({
name: 'Contract Review',
documents: ['doc-123'],
recipients: [
{ email: '[email protected]', name: 'Jane Doe', role: 'signer' },
],
});
// Send envelope
await client.sendEnvelope(envelope.id);
// Check signature status
const status = await client.getSignatureStatus('doc-123');API Reference
DocumentsClient
createEnvelope(envelopeDef)
Create a document envelope.
const envelope = await client.createEnvelope({
name: 'NDA',
documents: ['doc-456'],
recipients: [
{ email: '[email protected]', name: 'Legal Team', role: 'signer' },
],
});requestSignature(documentId, signers)
Request signatures on a document.
await client.requestSignature('doc-456', [
{ email: '[email protected]', name: 'User 1', role: 'signer' },
{ email: '[email protected]', name: 'User 2', role: 'approver' },
]);getSignatureStatus(documentId)
Get signature status.
const status = await client.getSignatureStatus('doc-456');createTemplate(templateDef)
Create a document template.
const template = await client.createTemplate({
name: 'Service Agreement',
content: '<html>...</html>',
});License
MIT