Interface: DocumentService

Defined in: domain/contracts.ts:478

Document lifecycle operations.

Methods

createDocument()

createDocument(input): Promise<DocumentInstance<string>>;

Defined in: domain/contracts.ts:480

Creates a document for a profile, optionally from a template or with initial data.

Parameters

Parameter	Type
input	{ data?: DocumentData; folderId?: string; profileId: string; templateId?: string; }
input.data?	DocumentData
input.folderId?	string
input.profileId	string
input.templateId?	string

Returns

Promise<DocumentInstance<string>>

---

deleteDocument()

deleteDocument(input): Promise<void>;

Defined in: domain/contracts.ts:491

Deletes a document.

Parameters

Parameter	Type
input	{ documentId: string; }
input.documentId	string

Returns

Promise<void>

---

duplicateDocument()

duplicateDocument(input): Promise<DocumentInstance<string>>;

Defined in: domain/contracts.ts:493

Creates a copy of a document.

Parameters

Parameter	Type
input	{ documentId: string; targetFolderId?: string; }
input.documentId	string
input.targetFolderId?	string

Returns

Promise<DocumentInstance<string>>

---

getDocument()

getDocument(documentId): Promise<DocumentInstance<string>>;

Defined in: domain/contracts.ts:495

Returns a document by id.

Parameters

Parameter	Type
documentId	string

Returns

Promise<DocumentInstance<string>>

---

moveDocument()

moveDocument(input): Promise<void>;

Defined in: domain/contracts.ts:489

Moves a document to another folder.

Parameters

Parameter	Type
input	{ documentId: string; targetFolderId: string; }
input.documentId	string
input.targetFolderId	string

Returns

Promise<void>

---

updateDocument()

updateDocument(input): Promise<DocumentInstance<string>>;

Defined in: domain/contracts.ts:487

Replaces the data of a document.

Parameters

Parameter	Type
input	{ data: DocumentData; documentId: string; }
input.data	DocumentData
input.documentId	string

Returns

Promise<DocumentInstance<string>>