Explorer/Client Reference/Document Management
Document Management packages/clients/generated/document-management
Domain: document-management · API spec: packages/resolved/document-management-openapi.yamlView full API reference →

Documents (4)

▶ listDocuments() You can provide a client instance returned by `createClient()` instead of API ref → 
document-management.listDocuments({
  query: { q?: string, limit?: number, offset?: number, sort?: string, documentTypeId?: string, lifecycleState?: enum: },
})
Parameters
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
documentTypeId string query optional
lifecycleState enum: "active", "retained", "pending_disposition", "destroyed" query optional
▶ uploadDocument() Upload a document API ref → 
document-management.uploadDocument({ body: { ... } })
Parameters
body object body required
▶ getDocument(documentId) Get a document API ref → 
document-management.getDocument({ path: { documentId: string } })
Parameters
documentId string path required
▶ updateDocument(documentId) Update a document API ref → 
document-management.updateDocument({
  path: { documentId: string },
  body: { ... },
})
Parameters
documentId string path required
body object body required

Metadata (2)

▶ deleteDocumentMetadata(documentId, domain) Remove domain metadata from a document API ref → 
document-management.deleteDocumentMetadata({
  path: { documentId: string, domain: enum (6 values) },
})
Parameters
documentId string path required
domain enum (6 values) path required
▶ setDocumentMetadata(documentId, domain) Set domain metadata on a document API ref → 
document-management.setDocumentMetadata({
  path: { documentId: string, domain: enum (6 values) },
  body: { ... },
})
Parameters
documentId string path required
domain enum (6 values) path required
body object body required

Document Versions (2)

▶ uploadDocumentVersion(documentId) Upload a new version API ref → 
document-management.uploadDocumentVersion({
  path: { documentId: string },
  body: { ... },
})
Parameters
documentId string path required
body object body required
▶ getDocumentVersion(documentVersionId) Get a document version API ref → 
document-management.getDocumentVersion({
  path: { documentVersionId: string },
})
Parameters
documentVersionId string path required

Content (1)

▶ getDocumentVersionContent(documentVersionId) Get file content API ref → 
document-management.getDocumentVersionContent({
  path: { documentVersionId: string },
})
Parameters
documentVersionId string path required

Document Types (4)

▶ listDocumentTypes() List document types API ref → 
document-management.listDocumentTypes({
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ createDocumentType() Create a document type API ref → 
document-management.createDocumentType({ body: { ... } })
Parameters
body object body required
▶ deleteDocumentType(documentTypeId) Delete a document type API ref → 
document-management.deleteDocumentType({
  path: { documentTypeId: string },
})
Parameters
documentTypeId string path required
▶ getDocumentType(documentTypeId) Get a document type API ref → 
document-management.getDocumentType({
  path: { documentTypeId: string },
})
Parameters
documentTypeId string path required

Constants (2)

▶ DocumentLifecycleState enum (4 values)
'active'
'retained'
'pending_disposition'
'destroyed'
▶ RetentionTrigger enum (4 values)
'case_closure'
'application_denial'
'document_date'
'submission_date'

Types (12)

▶ Document 13 fields
interface Document {
id: string
documentTypeId: string
title: string
documentDate?: string
lifecycleState: enum: "active", "retained", "pending_disposition", "destroyed"
legalHold: boolean
latestVersionId: string
retentionDeadline?: string
metadata?: object
dispositionApprovedBy?: string
dispositionApprovedAt?: string
createdAt: string
updatedAt: string
}
▶ DocumentUpdate 2 fields
interface DocumentUpdate {
title?: string
documentDate?: string
}
▶ DocumentList 5 fields
interface DocumentList {
items: array[object]
total: number
limit: number
offset: number
hasNext: boolean
}
▶ DocumentVersion 9 fields
interface DocumentVersion {
id: string
documentId: string
versionNumber: number
fileName: string
mimeType: string
sizeBytes: number
contentHash: string
uploadedById: string
createdAt: string
}
▶ DocumentType 7 fields
interface DocumentType {
id: string
name: string
retentionYears: number
retentionTrigger: enum: "case_closure", "application_denial", "document_date", "submission_date"
source: enum: "system", "user"
createdAt: string
updatedAt: string
}
▶ DocumentTypeCreate 3 fields
interface DocumentTypeCreate {
name: string
retentionYears: number
retentionTrigger: enum: "case_closure", "application_denial", "document_date", "submission_date"
}
▶ DocumentTypeList 5 fields
interface DocumentTypeList {
items: array[object]
total: number
limit: number
offset: number
hasNext: boolean
}
▶ DocumentLink 7 fields
interface DocumentLink {
id: string
documentId: string
subjectType: enum: "application", "case"
subjectId: string
linkedBy: string
closedAt?: string
createdAt: string
}
▶ DocumentLinkCreate 3 fields
interface DocumentLinkCreate {
documentId: string
subjectType: enum: "application", "case"
subjectId: string
}
▶ DocumentLinkList 5 fields
interface DocumentLinkList {
items: array[object]
total: number
limit: number
offset: number
hasNext: boolean
}
▶ DocumentTypeWritable 6 fields
interface DocumentTypeWritable {
id: string
name: string
retentionYears: number
retentionTrigger: enum: "case_closure", "application_denial", "document_date", "submission_date"
createdAt: string
updatedAt: string
}
▶ DocumentTypeListWritable 5 fields
interface DocumentTypeListWritable {
items: array[object]
total: number
limit: number
offset: number
hasNext: boolean
}