@korala/public-dtos

TypeScript type definitions for the Korala document signing API.

Installation

npm install @korala/public-dtos

Usage

import {
  DocumentStatus,
  FieldType,
  type DocumentDto,
  type SignerDto,
} from '@korala/public-dtos';

function isComplete(doc: DocumentDto): boolean {
  return doc.status === DocumentStatus.Completed;
}

Note: Most users should use @korala/api-client which re-exports all types from this package. Install this package directly only if you need the types without the API client.

Exported Types

Enums

| Enum | Values | |------|--------| | DocumentStatus | Draft, Pending, Completed, Voided, Declined | | FieldType | Signature, Initials, Date, Text, Checkbox | | AuthMethod | Bearer, Hmac | | SignerStatus | Pending, Viewed, Signed, Declined |

DTOs

Documents, signers, fields, templates, webhooks, signatures, and all request/response types used by the Korala API.

Documentation

Full API documentation at docs.korala.ai.

License

MIT