@managemint-solutions/entities 1.36.0 → 1.46.0

package/dist/audit-trail/enum/index.d.ts

@@ -4,7 +4,9 @@ export declare enum AuditTrailAction {
     ARCHIVE = "ARCHIVE",
     UNARCHIVE = "UNARCHIVE",
     DELETE = "DELETE",
-    RESTORE = "RESTORE"
+    RESTORE = "RESTORE",
+    /** A document emailed: its changes hold recipients, cc, subject and pay_now as sent. */
+    SEND = "SEND"
 }
 export declare enum AuditTrailEntityType {
     ORGANIZATION = "organizations",
@@ -28,11 +30,19 @@ export declare enum AuditTrailEntityType {
     BILLING_TRANSACTIONS = "billing_transactions",
     INVOICE = "invoices",
     NOTIFICATION = "notifications",
-    USER_API_CREDENTIAL = "user_api_credentials"
+    USER_API_CREDENTIAL = "user_api_credentials",
+    DOCUMENT_TEMPLATES = "document_templates",
+    DOCUMENTS = "documents",
+    VISIBILITY = "visibility",
+    PAYMENTS = "payments"
 }
 export declare enum AuditTrailChangeType {
     TEXT = "text",
     DATE = "date",
     DATETIME = "datetime",
-    REDACTED = "redacted"
+    REDACTED = "redacted",
+    /** One block of a template or document: `block` says what happened to it. */
+    BLOCK = "block",
+    /** One variable definition of a template or document: `variable` says what happened to it. */
+    VARIABLE = "variable"
 }

package/dist/audit-trail/enum/index.js

@@ -9,6 +9,8 @@ var AuditTrailAction;
     AuditTrailAction["UNARCHIVE"] = "UNARCHIVE";
     AuditTrailAction["DELETE"] = "DELETE";
     AuditTrailAction["RESTORE"] = "RESTORE";
+    /** A document emailed: its changes hold recipients, cc, subject and pay_now as sent. */
+    AuditTrailAction["SEND"] = "SEND";
 })(AuditTrailAction || (exports.AuditTrailAction = AuditTrailAction = {}));
 var AuditTrailEntityType;
 (function (AuditTrailEntityType) {
@@ -34,6 +36,10 @@ var AuditTrailEntityType;
     AuditTrailEntityType["INVOICE"] = "invoices";
     AuditTrailEntityType["NOTIFICATION"] = "notifications";
     AuditTrailEntityType["USER_API_CREDENTIAL"] = "user_api_credentials";
+    AuditTrailEntityType["DOCUMENT_TEMPLATES"] = "document_templates";
+    AuditTrailEntityType["DOCUMENTS"] = "documents";
+    AuditTrailEntityType["VISIBILITY"] = "visibility";
+    AuditTrailEntityType["PAYMENTS"] = "payments";
 })(AuditTrailEntityType || (exports.AuditTrailEntityType = AuditTrailEntityType = {}));
 var AuditTrailChangeType;
 (function (AuditTrailChangeType) {
@@ -41,4 +47,8 @@ var AuditTrailChangeType;
     AuditTrailChangeType["DATE"] = "date";
     AuditTrailChangeType["DATETIME"] = "datetime";
     AuditTrailChangeType["REDACTED"] = "redacted";
+    /** One block of a template or document: `block` says what happened to it. */
+    AuditTrailChangeType["BLOCK"] = "block";
+    /** One variable definition of a template or document: `variable` says what happened to it. */
+    AuditTrailChangeType["VARIABLE"] = "variable";
 })(AuditTrailChangeType || (exports.AuditTrailChangeType = AuditTrailChangeType = {}));

package/dist/audit-trail/index.d.ts

@@ -1,3 +1,4 @@
+import type { DocumentBlockChange, DocumentVariableChange } from "../documents";
 import { UserIdentity } from "../users";
 import { AuditTrailAction, AuditTrailChangeType, AuditTrailEntityType } from "./enum";
 export type AuditTrailEntity = {
@@ -7,9 +8,15 @@ export type AuditTrailEntity = {
     action: AuditTrailAction;
     entity_type: AuditTrailEntityType;
     entity_id: string;
+    /**
+     * As stored. A template's or document's `blocks`, `variables` and `variable_values` keep
+     * `'[redacted]'` on both sides and say what changed in `diff` instead: DocumentBlockChange[],
+     * DocumentVariableChange[] and DocumentValueChange[]. Its `email` keeps only the keys that moved.
+     */
     changes: Record<string, {
         old: any;
         new: any;
+        diff?: unknown[];
     }>;
     related_entity_type: AuditTrailEntityType | null;
     related_entity_id: string | null;
@@ -18,7 +25,9 @@ export type AuditTrailEntity = {
  * One changed field as a record's history shows it: the column, its readable label, and both
  * sides already turned into display text (a status id into the status label, a boolean into
  * Yes/No). `DATE` and `DATETIME` values stay ISO strings for the portal to format; `REDACTED`
- * carries no values, only that the field changed.
+ * carries no values, only that the field changed. `BLOCK` and `VARIABLE` carry no text either
+ * (`old` and `new` are null): their `block` or `variable` says, as data, what happened to one
+ * block or one variable definition of a template or document.
  */
 export type AuditTrailChange = {
     field: string;
@@ -26,6 +35,10 @@ export type AuditTrailChange = {
     type: AuditTrailChangeType;
     old: string | null;
     new: string | null;
+    /** On a `BLOCK` change only. */
+    block?: DocumentBlockChange;
+    /** On a `VARIABLE` change only. */
+    variable?: DocumentVariableChange;
 };
 /**
  * One entry in a record's history. `entity_type` is what changed: the record itself, or a row

package/dist/clients/dto/index.d.ts

@@ -1,4 +1,5 @@
 import { UUID } from "crypto";
+import type { ClientBillingDetails } from '..';
 export type GetClientsDto = {
     search?: string | null;
     page: number;
@@ -15,7 +16,9 @@ export type StaffGetClientsDto = GetClientsDto & {
 export type ClientIdDto = {
     clientId: string;
 };
-export type CreateClientDto = {
+/** The billing details on a create or a save; each optional, null clears, left out keeps. */
+export type ClientBillingDetailsDto = Partial<ClientBillingDetails>;
+export type CreateClientDto = ClientBillingDetailsDto & {
     name: string;
     email: string | null;
     phone: string | null;
@@ -23,7 +26,7 @@ export type CreateClientDto = {
     contract_client: boolean;
     contracted_hours: number | null;
 };
-export type UpdateClientDto = {
+export type UpdateClientDto = ClientBillingDetailsDto & {
     name: string;
     email: string | null;
     phone: string | null;

package/dist/clients/index.d.ts

@@ -16,7 +16,21 @@ export type ClientSummary = {
     /** Present on staff reads only. */
     organization?: OrganizationIdentity;
 };
-export type ClientEntity = {
+/**
+ * What a document bills a client by: an address in the organization's own address shape, a
+ * registration number and a VAT number. Every one optional (null when not given).
+ */
+export type ClientBillingDetails = {
+    address_line_1: string | null;
+    address_line_2: string | null;
+    city: string | null;
+    state: string | null;
+    post_code: string | null;
+    country: string | null;
+    registration_number: string | null;
+    vat_number: string | null;
+};
+export type ClientEntity = ClientBillingDetails & {
     mms_id: UUID;
     created_at: Date;
     name: string;
@@ -38,4 +52,6 @@ export type ClientEntity = {
     deleted_by: UserIdentity | null;
     restored_at: Date | null;
     restored_by: UserIdentity | null;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
 };

package/dist/documents/dto/index.d.ts

@@ -0,0 +1,148 @@
+import type { DocumentBlock, DocumentEmail, DocumentVariable, DocumentVariableValues } from '..';
+import { DocumentPaymentFilter, DocumentRepeat, DocumentStatus, DocumentVisibility } from '../enum';
+export type GetDocumentTemplatesDto = {
+    /** Matches the name and the category. */
+    search?: string | null;
+    category?: string | null;
+    archive: boolean;
+    page: number;
+    page_size: number;
+};
+export type DocumentTemplateIdDto = {
+    templateId: string;
+};
+/**
+ * A whole template. Every variable a block uses must be declared in `variables` or be a system
+ * variable, and a line's quantity or price may only point at a number or money variable.
+ */
+export type CreateDocumentTemplateDto = {
+    name: string;
+    category?: string;
+    number_prefix?: string;
+    /** Omitted is ORGANIZATION. After create it changes only through the sharing route. */
+    visibility?: DocumentVisibility;
+    variables: DocumentVariable[];
+    blocks: DocumentBlock[];
+};
+/**
+ * Saving replaces the whole template, so the checks above always see it complete. Its visibility
+ * is not part of a save - it changes only through the sharing route.
+ */
+export type UpdateDocumentTemplateDto = Omit<CreateDocumentTemplateDto, 'visibility'>;
+export type GetDocumentsDto = {
+    /** Matches the title and the number. */
+    search?: string | null;
+    category?: string | null;
+    status?: DocumentStatus | null;
+    client_id?: string | null;
+    template_id?: string | null;
+    /** True lists recurring parents only; otherwise parents are left out. */
+    recurring?: boolean;
+    /** The drafts and documents one recurring parent made. */
+    repeat_from?: string | null;
+    /** Paid (paid twice included), or unpaid: issued, a total above zero, nothing settled. */
+    payment?: DocumentPaymentFilter | null;
+    page: number;
+    page_size: number;
+};
+/**
+ * A recurring parent's schedule, or a draft's issue date - on create and on a draft save. A
+ * parent needs `repeat_next_at` (its first issue date) and cannot have `issue_at`; null clears.
+ */
+export type DocumentScheduleDto = {
+    repeat?: DocumentRepeat | null;
+    repeat_next_at?: string | null;
+    repeat_until?: string | null;
+    repeat_paused?: boolean;
+    issue_at?: string | null;
+    email?: DocumentEmail | null;
+};
+export type DocumentIdDto = {
+    documentId: string;
+};
+/**
+ * A new draft. With a template, it copies the template's blocks, variables, category and prefix,
+ * and starts from the template's defaults overlaid by `variable_values`. Without one, it starts
+ * blank and is built on the draft itself.
+ */
+export type CreateDocumentDto = DocumentScheduleDto & {
+    template_id?: string | null;
+    client_id?: string | null;
+    title?: string;
+    /** Required once the document has a line items block. */
+    currency?: string | null;
+    variable_values?: DocumentVariableValues;
+    /** A blank draft's setting; one made from a template takes the template's (and its shares). */
+    visibility?: DocumentVisibility;
+};
+/**
+ * A draft's edits, whole, under the same checks as a template. Only drafts can be updated. Its
+ * visibility is not part of a save - it changes only through the sharing route.
+ */
+export type UpdateDocumentDto = DocumentScheduleDto & {
+    client_id: string | null;
+    title: string;
+    category: string;
+    number_prefix: string;
+    currency: string | null;
+    variables: DocumentVariable[];
+    variable_values: DocumentVariableValues;
+    blocks: DocumentBlock[];
+};
+export type VoidDocumentDto = {
+    reason: string;
+};
+/** The image an image block is about to upload; only its extension is kept. */
+export type DocumentImageNameDto = {
+    name: string;
+};
+/**
+ * Image blocks' paths to sign for reading (`documents/images/<id>.<ext>`, as an upload target
+ * returned them) - for a page the caller renders itself, such as the portal's live preview.
+ */
+export type DocumentImageUrlsDto = {
+    paths: string[];
+};
+/**
+ * The organization owner moves one person's private templates and documents to another, without
+ * seeing them - for someone who has left.
+ */
+export type ReassignPrivateDocumentsDto = {
+    from_user_id: string;
+    to_user_id: string;
+};
+/**
+ * Emails an issued document, its PDF attached - the stored DocumentEmail shape. `{{key}}`s in the
+ * subject and message are filled from the document's values. `pay_now` adds the public pay link,
+ * and is refused unless the document's `pay_now_available`.
+ */
+export type SendDocumentDto = DocumentEmail;
+/** A public pay link's token (`/pay/<token>`): the document's mms_id, a dot, and the api's signature of it. */
+export type DocumentPayTokenDto = {
+    token: string;
+};
+/**
+ * The pay page's read. `reference` is what Paystack hands back on its return to the page
+ * (`?reference=`): with it, the api asks Paystack about that checkout and settles it before
+ * answering, so the page says paid without waiting for the webhook.
+ */
+export type DocumentPayQueryDto = {
+    reference?: string;
+};
+/** The payer's email, for Paystack's receipt. */
+export type PayDocumentDto = {
+    email: string;
+};
+/**
+ * Marks an issued document paid by hand - an EFT the organization received: the whole total, in
+ * the document's currency, on `paid_at` (YYYY-MM-DD).
+ */
+export type RecordDocumentPaymentDto = {
+    paid_at: string;
+    /** The bank reference, up to 100 characters. */
+    reference?: string | null;
+};
+export type DocumentPaymentIdDto = {
+    documentId: string;
+    paymentId: string;
+};

package/dist/documents/dto/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/documents/enum/index.d.ts

@@ -0,0 +1,127 @@
+/** Where a document is in its life. Stored as plain text; the sdk DTO validates it against this list. */
+export declare enum DocumentStatus {
+    /** Editable; no number yet. */
+    DRAFT = "draft",
+    /** Numbered and frozen; it never changes again, it can only be voided. */
+    ISSUED = "issued",
+    /** Cancelled after issue, with a reason. Kept, never deleted. */
+    VOID = "void"
+}
+/**
+ * Who sees a template or document. A document made from a template starts with the template's.
+ * Stored as plain text; the sdk DTOs validate it against this list.
+ */
+export declare enum DocumentVisibility {
+    /** Everyone in the organization, governed by the documents permissions. */
+    ORGANIZATION = "organization",
+    /** Its creator and the people it is shared with - not the organization's owners or admins. */
+    PRIVATE = "private"
+}
+/**
+ * The kinds of block a template or document is built from. A new kind is a member here and a
+ * shape in ../index.ts - never a migration, because blocks are stored as JSON.
+ */
+export declare enum DocumentBlockType {
+    /** Rich text: paragraphs, headings, lists, emphasis, links and variables. */
+    TEXT = "text",
+    /** Label and value pairs, such as "Start date: 1 November 2026". */
+    FIELDS = "fields",
+    /** Priced lines with quantity, unit price, discount and tax, and their totals. */
+    LINE_ITEMS = "line_items",
+    /** A plain table of text cells. */
+    TABLE = "table",
+    /** Signature lines for the named parties. */
+    SIGNATURE = "signature",
+    /** An uploaded image, such as a logo or a diagram. */
+    IMAGE = "image",
+    /** Starts a new page in the PDF. */
+    PAGE_BREAK = "page_break",
+    /** Left and right text repeated at the top of every PDF page; one per document. */
+    HEADER = "header",
+    /** Left and right text repeated at the foot of every PDF page; one per document. */
+    FOOTER = "footer",
+    /** Two or three columns side by side, each a heading and plain text - "Bill from" and "Bill to". */
+    COLUMNS = "columns"
+}
+/** What a variable holds, which decides its input and how its value prints. */
+export declare enum DocumentVariableType {
+    TEXT = "text",
+    NUMBER = "number",
+    /** Integer cents, printed in the document's currency. */
+    MONEY = "money",
+    /** A calendar date, YYYY-MM-DD, printed like "1 November 2026". */
+    DATE = "date"
+}
+/**
+ * The variables the api fills in itself, so a template never declares them. A draft shows them
+ * live; issuing freezes their values on the document.
+ */
+export declare enum DocumentSystemVariable {
+    ORGANIZATION_NAME = "organization_name",
+    ORGANIZATION_ADDRESS = "organization_address",
+    CLIENT_NAME = "client_name",
+    CLIENT_EMAIL = "client_email",
+    CLIENT_PHONE = "client_phone",
+    DOCUMENT_NUMBER = "document_number",
+    /** The date the document was issued (today on a draft). */
+    ISSUE_DATE = "issue_date",
+    /** The issue date's month name and year, for wording such as "Support for October 2026". */
+    MONTH = "month",
+    YEAR = "year",
+    /** The PDF page being printed; only inside a header or footer. */
+    PAGE_NUMBER = "page_number",
+    /** How many pages the PDF has; only inside a header or footer. */
+    PAGE_COUNT = "page_count",
+    ORGANIZATION_REGISTRATION_NUMBER = "organization_registration_number",
+    ORGANIZATION_VAT_NUMBER = "organization_vat_number",
+    ORGANIZATION_EMAIL = "organization_email",
+    ORGANIZATION_PHONE = "organization_phone",
+    /** The client's address lines, joined as the organization's are. */
+    CLIENT_ADDRESS = "client_address",
+    CLIENT_REGISTRATION_NUMBER = "client_registration_number",
+    CLIENT_VAT_NUMBER = "client_vat_number"
+}
+/** Where a document stands on its public pay page (`GET /pay/:token`). */
+export declare enum DocumentPayStatus {
+    /** Issued, in rands, a total above zero, unpaid, and the organization takes payouts. */
+    PAYABLE = "payable",
+    /** At least one payment has settled. */
+    PAID = "paid",
+    VOID = "void",
+    /** Issued but not payable online: another currency, nothing to pay, or payouts are off. */
+    UNAVAILABLE = "unavailable"
+}
+/** How often a recurring document makes its next draft. Stored as plain text. */
+export declare enum DocumentRepeat {
+    WEEKLY = "weekly",
+    /** The same day each month; a month-end date stays on the last day of the month. */
+    MONTHLY = "monthly",
+    QUARTERLY = "quarterly",
+    YEARLY = "yearly"
+}
+/**
+ * Where an issued document's money stands, worked out by the api from its payments: null unless
+ * it is issued with a total above zero.
+ */
+export declare enum DocumentPaymentStatus {
+    UNPAID = "unpaid",
+    PAID = "paid",
+    /** Two payments settled - two people paid at once; the owner refunds one. */
+    PAID_TWICE = "paid_twice"
+}
+/** How one block or variable moved between two saves, as a record's history records it. */
+export declare enum DocumentChangeKind {
+    ADDED = "added",
+    REMOVED = "removed",
+    /** Only its place in the list changed (blocks only). */
+    MOVED = "moved",
+    /** Its content changed - and, for a block, maybe its place too. */
+    CHANGED = "changed"
+}
+/** The documents list's payment filter (`GetDocumentsDto.payment`). */
+export declare enum DocumentPaymentFilter {
+    /** Has a settled payment - paid twice included. */
+    PAID = "paid",
+    /** Issued, a total above zero, and no settled payment yet. */
+    UNPAID = "unpaid"
+}

package/dist/documents/enum/index.js

@@ -0,0 +1,140 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentPaymentFilter = exports.DocumentChangeKind = exports.DocumentPaymentStatus = exports.DocumentRepeat = exports.DocumentPayStatus = exports.DocumentSystemVariable = exports.DocumentVariableType = exports.DocumentBlockType = exports.DocumentVisibility = exports.DocumentStatus = void 0;
+/** Where a document is in its life. Stored as plain text; the sdk DTO validates it against this list. */
+var DocumentStatus;
+(function (DocumentStatus) {
+    /** Editable; no number yet. */
+    DocumentStatus["DRAFT"] = "draft";
+    /** Numbered and frozen; it never changes again, it can only be voided. */
+    DocumentStatus["ISSUED"] = "issued";
+    /** Cancelled after issue, with a reason. Kept, never deleted. */
+    DocumentStatus["VOID"] = "void";
+})(DocumentStatus || (exports.DocumentStatus = DocumentStatus = {}));
+/**
+ * Who sees a template or document. A document made from a template starts with the template's.
+ * Stored as plain text; the sdk DTOs validate it against this list.
+ */
+var DocumentVisibility;
+(function (DocumentVisibility) {
+    /** Everyone in the organization, governed by the documents permissions. */
+    DocumentVisibility["ORGANIZATION"] = "organization";
+    /** Its creator and the people it is shared with - not the organization's owners or admins. */
+    DocumentVisibility["PRIVATE"] = "private";
+})(DocumentVisibility || (exports.DocumentVisibility = DocumentVisibility = {}));
+/**
+ * The kinds of block a template or document is built from. A new kind is a member here and a
+ * shape in ../index.ts - never a migration, because blocks are stored as JSON.
+ */
+var DocumentBlockType;
+(function (DocumentBlockType) {
+    /** Rich text: paragraphs, headings, lists, emphasis, links and variables. */
+    DocumentBlockType["TEXT"] = "text";
+    /** Label and value pairs, such as "Start date: 1 November 2026". */
+    DocumentBlockType["FIELDS"] = "fields";
+    /** Priced lines with quantity, unit price, discount and tax, and their totals. */
+    DocumentBlockType["LINE_ITEMS"] = "line_items";
+    /** A plain table of text cells. */
+    DocumentBlockType["TABLE"] = "table";
+    /** Signature lines for the named parties. */
+    DocumentBlockType["SIGNATURE"] = "signature";
+    /** An uploaded image, such as a logo or a diagram. */
+    DocumentBlockType["IMAGE"] = "image";
+    /** Starts a new page in the PDF. */
+    DocumentBlockType["PAGE_BREAK"] = "page_break";
+    /** Left and right text repeated at the top of every PDF page; one per document. */
+    DocumentBlockType["HEADER"] = "header";
+    /** Left and right text repeated at the foot of every PDF page; one per document. */
+    DocumentBlockType["FOOTER"] = "footer";
+    /** Two or three columns side by side, each a heading and plain text - "Bill from" and "Bill to". */
+    DocumentBlockType["COLUMNS"] = "columns";
+})(DocumentBlockType || (exports.DocumentBlockType = DocumentBlockType = {}));
+/** What a variable holds, which decides its input and how its value prints. */
+var DocumentVariableType;
+(function (DocumentVariableType) {
+    DocumentVariableType["TEXT"] = "text";
+    DocumentVariableType["NUMBER"] = "number";
+    /** Integer cents, printed in the document's currency. */
+    DocumentVariableType["MONEY"] = "money";
+    /** A calendar date, YYYY-MM-DD, printed like "1 November 2026". */
+    DocumentVariableType["DATE"] = "date";
+})(DocumentVariableType || (exports.DocumentVariableType = DocumentVariableType = {}));
+/**
+ * The variables the api fills in itself, so a template never declares them. A draft shows them
+ * live; issuing freezes their values on the document.
+ */
+var DocumentSystemVariable;
+(function (DocumentSystemVariable) {
+    DocumentSystemVariable["ORGANIZATION_NAME"] = "organization_name";
+    DocumentSystemVariable["ORGANIZATION_ADDRESS"] = "organization_address";
+    DocumentSystemVariable["CLIENT_NAME"] = "client_name";
+    DocumentSystemVariable["CLIENT_EMAIL"] = "client_email";
+    DocumentSystemVariable["CLIENT_PHONE"] = "client_phone";
+    DocumentSystemVariable["DOCUMENT_NUMBER"] = "document_number";
+    /** The date the document was issued (today on a draft). */
+    DocumentSystemVariable["ISSUE_DATE"] = "issue_date";
+    /** The issue date's month name and year, for wording such as "Support for October 2026". */
+    DocumentSystemVariable["MONTH"] = "month";
+    DocumentSystemVariable["YEAR"] = "year";
+    /** The PDF page being printed; only inside a header or footer. */
+    DocumentSystemVariable["PAGE_NUMBER"] = "page_number";
+    /** How many pages the PDF has; only inside a header or footer. */
+    DocumentSystemVariable["PAGE_COUNT"] = "page_count";
+    DocumentSystemVariable["ORGANIZATION_REGISTRATION_NUMBER"] = "organization_registration_number";
+    DocumentSystemVariable["ORGANIZATION_VAT_NUMBER"] = "organization_vat_number";
+    DocumentSystemVariable["ORGANIZATION_EMAIL"] = "organization_email";
+    DocumentSystemVariable["ORGANIZATION_PHONE"] = "organization_phone";
+    /** The client's address lines, joined as the organization's are. */
+    DocumentSystemVariable["CLIENT_ADDRESS"] = "client_address";
+    DocumentSystemVariable["CLIENT_REGISTRATION_NUMBER"] = "client_registration_number";
+    DocumentSystemVariable["CLIENT_VAT_NUMBER"] = "client_vat_number";
+})(DocumentSystemVariable || (exports.DocumentSystemVariable = DocumentSystemVariable = {}));
+/** Where a document stands on its public pay page (`GET /pay/:token`). */
+var DocumentPayStatus;
+(function (DocumentPayStatus) {
+    /** Issued, in rands, a total above zero, unpaid, and the organization takes payouts. */
+    DocumentPayStatus["PAYABLE"] = "payable";
+    /** At least one payment has settled. */
+    DocumentPayStatus["PAID"] = "paid";
+    DocumentPayStatus["VOID"] = "void";
+    /** Issued but not payable online: another currency, nothing to pay, or payouts are off. */
+    DocumentPayStatus["UNAVAILABLE"] = "unavailable";
+})(DocumentPayStatus || (exports.DocumentPayStatus = DocumentPayStatus = {}));
+/** How often a recurring document makes its next draft. Stored as plain text. */
+var DocumentRepeat;
+(function (DocumentRepeat) {
+    DocumentRepeat["WEEKLY"] = "weekly";
+    /** The same day each month; a month-end date stays on the last day of the month. */
+    DocumentRepeat["MONTHLY"] = "monthly";
+    DocumentRepeat["QUARTERLY"] = "quarterly";
+    DocumentRepeat["YEARLY"] = "yearly";
+})(DocumentRepeat || (exports.DocumentRepeat = DocumentRepeat = {}));
+/**
+ * Where an issued document's money stands, worked out by the api from its payments: null unless
+ * it is issued with a total above zero.
+ */
+var DocumentPaymentStatus;
+(function (DocumentPaymentStatus) {
+    DocumentPaymentStatus["UNPAID"] = "unpaid";
+    DocumentPaymentStatus["PAID"] = "paid";
+    /** Two payments settled - two people paid at once; the owner refunds one. */
+    DocumentPaymentStatus["PAID_TWICE"] = "paid_twice";
+})(DocumentPaymentStatus || (exports.DocumentPaymentStatus = DocumentPaymentStatus = {}));
+/** How one block or variable moved between two saves, as a record's history records it. */
+var DocumentChangeKind;
+(function (DocumentChangeKind) {
+    DocumentChangeKind["ADDED"] = "added";
+    DocumentChangeKind["REMOVED"] = "removed";
+    /** Only its place in the list changed (blocks only). */
+    DocumentChangeKind["MOVED"] = "moved";
+    /** Its content changed - and, for a block, maybe its place too. */
+    DocumentChangeKind["CHANGED"] = "changed";
+})(DocumentChangeKind || (exports.DocumentChangeKind = DocumentChangeKind = {}));
+/** The documents list's payment filter (`GetDocumentsDto.payment`). */
+var DocumentPaymentFilter;
+(function (DocumentPaymentFilter) {
+    /** Has a settled payment - paid twice included. */
+    DocumentPaymentFilter["PAID"] = "paid";
+    /** Issued, a total above zero, and no settled payment yet. */
+    DocumentPaymentFilter["UNPAID"] = "unpaid";
+})(DocumentPaymentFilter || (exports.DocumentPaymentFilter = DocumentPaymentFilter = {}));