@managemint-solutions/entities 1.36.0 → 1.46.0

package/dist/documents/index.d.ts

@@ -0,0 +1,390 @@
+import type { UUID } from 'crypto';
+import type { ClientIdentity } from '../clients';
+import type { OrganizationIdentity } from '../organization';
+import type { Payment } from '../payments';
+import type { UserIdentity } from '../users';
+import type { VisibilityRole } from '../visibility/enum';
+import { DocumentBlockType, DocumentChangeKind, DocumentPaymentStatus, DocumentPayStatus, DocumentRepeat, DocumentStatus, DocumentVariableType, DocumentVisibility } from './enum';
+/**
+ * A filled-in value: text and dates (YYYY-MM-DD) as strings, numbers as numbers, money as
+ * integer cents.
+ */
+export type DocumentVariableValue = string | number;
+/**
+ * One input a template asks for. Blocks refer to it by `key`: `{{key}}` inside plain text
+ * (fields, table cells, line descriptions, signer labels) and a variable node inside rich text.
+ * Keys are lower snake_case and unique within the template.
+ */
+export type DocumentVariable = {
+    key: string;
+    label: string;
+    type: DocumentVariableType;
+    /** A document cannot be issued while a required variable has no value. */
+    required: boolean;
+    /** Prefills the input when a document is created from the template. */
+    default_value: DocumentVariableValue | null;
+};
+/**
+ * A document's filled-in values, by variable key: its template variables, and once it is
+ * issued the system variables too (DocumentSystemVariable), frozen at issue.
+ */
+export type DocumentVariableValues = Record<string, DocumentVariableValue>;
+/** What every block carries: a stable id (kept across edits and reorders) and its type. */
+type DocumentBlockBase<T extends DocumentBlockType> = {
+    id: string;
+    type: T;
+};
+/**
+ * Rich text in the editor's own JSON (ProseMirror): paragraphs, headings, bullet and numbered
+ * lists, bold, italic, underline, links, and `{ "type": "variable", "attrs": { "key": "..." } }`
+ * nodes. Only those node and mark types are accepted; the sdk refuses anything else.
+ */
+export type DocumentRichText = {
+    type: 'doc';
+    content: unknown[];
+};
+export type DocumentTextBlock = DocumentBlockBase<DocumentBlockType.TEXT> & {
+    content: DocumentRichText;
+};
+export type DocumentFieldsBlock = DocumentBlockBase<DocumentBlockType.FIELDS> & {
+    fields: {
+        label: string;
+        value: string;
+    }[];
+};
+/** A number written into the line, or the key of a number or money variable to take it from. */
+export type DocumentLineAmount = number | {
+    variable: string;
+};
+export type DocumentLineItem = {
+    description: string;
+    quantity: DocumentLineAmount;
+    /** Integer cents, or a money variable. */
+    unit_price_minor: DocumentLineAmount;
+    /** 0 to 100. */
+    discount_percent: number;
+    /** 0 to 100. */
+    tax_rate: number;
+};
+/** Prints its lines and their totals; a document's totals are the sum of its line items blocks. */
+export type DocumentLineItemsBlock = DocumentBlockBase<DocumentBlockType.LINE_ITEMS> & {
+    items: DocumentLineItem[];
+};
+export type DocumentTableBlock = DocumentBlockBase<DocumentBlockType.TABLE> & {
+    /** The header row. */
+    columns: string[];
+    /** One array of cells per row, each as long as `columns`. */
+    rows: string[][];
+};
+export type DocumentSignatureBlock = DocumentBlockBase<DocumentBlockType.SIGNATURE> & {
+    /** One signature line per party, labelled, e.g. "Client" or "{{organization_name}}". */
+    signers: {
+        label: string;
+    }[];
+};
+export type DocumentImageBlock = DocumentBlockBase<DocumentBlockType.IMAGE> & {
+    /**
+     * The uploaded file's storage path inside the organization's folder, as the upload target
+     * returned it (`documents/images/<id>.png`); empty until an image is uploaded.
+     */
+    path: string;
+    alt: string;
+};
+/** Where the browser puts an image block's file, and the `path` the block then stores. */
+export type DocumentImageUploadTarget = {
+    path: string;
+    /** A signed upload URL for one PUT of the file's bytes. */
+    url: string;
+};
+export type DocumentPageBreakBlock = DocumentBlockBase<DocumentBlockType.PAGE_BREAK>;
+/**
+ * Two or three columns side by side - "Bill from" and "Bill to" on an invoice. Each is a heading
+ * and plain text with `{{key}}` variables and its line breaks kept; the text's first line prints
+ * as a name.
+ */
+export type DocumentColumnsBlock = DocumentBlockBase<DocumentBlockType.COLUMNS> & {
+    columns: {
+        heading: string;
+        text: string;
+    }[];
+};
+/**
+ * Text repeated on every PDF page, wherever the block sits in the list - the renderer takes it
+ * out of the flow. Either side may be empty. Plain text with `{{key}}` variables, and the only
+ * place `{{page_number}}` and `{{page_count}}` may be used. At most one header and one footer.
+ */
+type DocumentBandBlock<T extends DocumentBlockType.HEADER | DocumentBlockType.FOOTER> = DocumentBlockBase<T> & {
+    left: string;
+    right: string;
+};
+export type DocumentHeaderBlock = DocumentBandBlock<DocumentBlockType.HEADER>;
+export type DocumentFooterBlock = DocumentBandBlock<DocumentBlockType.FOOTER>;
+export type DocumentBlock = DocumentTextBlock | DocumentFieldsBlock | DocumentLineItemsBlock | DocumentTableBlock | DocumentSignatureBlock | DocumentImageBlock | DocumentPageBreakBlock | DocumentHeaderBlock | DocumentFooterBlock | DocumentColumnsBlock;
+export type DocumentTemplateIdentity = {
+    mms_id: UUID;
+    name: string;
+};
+export type DocumentTemplateSummary = {
+    mms_id: UUID;
+    created_at: Date;
+    name: string;
+    category: string;
+    number_prefix: string;
+    archived: boolean;
+    visibility: DocumentVisibility;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
+};
+/**
+ * A reusable layout: an ordered list of blocks and the variables they use. Editing a template
+ * never changes a document already made from it - each document keeps its own copy.
+ */
+export type DocumentTemplateEntity = {
+    mms_id: UUID;
+    created_at: Date;
+    created_by: UserIdentity | null;
+    updated_at: Date | null;
+    last_updated_by: UserIdentity | null;
+    name: string;
+    /** The organization's own word for grouping and filtering (Invoice, Service Agreement). */
+    category: string;
+    /** Copied onto each document made from the template; documents are numbered per prefix. */
+    number_prefix: string;
+    variables: DocumentVariable[];
+    blocks: DocumentBlock[];
+    /** Which version of the block shapes `blocks` was written in. */
+    blocks_version: number;
+    archived: boolean;
+    archived_at: Date | null;
+    archived_by: UserIdentity | null;
+    visibility: DocumentVisibility;
+    /**
+     * What the caller may do with it, worked out by the api: the creator and an admin share are
+     * ADMIN; on an organization-visible record it follows the documents permissions.
+     */
+    my_role: VisibilityRole;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
+};
+/** A document as another one names it - a draft's recurring parent. */
+export type DocumentIdentity = {
+    mms_id: UUID;
+    title: string;
+};
+/**
+ * The email a document is sent in by the daily cron: on a recurring parent (copied onto each
+ * draft it makes) or on any draft with an `issue_at`. `subject` and `message` may use `{{key}}`
+ * variables - `{{document_number}}` included - filled from the document's values when it is sent.
+ */
+export type DocumentEmail = {
+    /** 1 to 5 addresses. */
+    to: string[];
+    /** 0 to 5 addresses. */
+    cc?: string[];
+    subject: string;
+    message: string;
+    /** Honoured only when the document is payable on the day. */
+    pay_now: boolean;
+};
+/**
+ * The repeat and schedule columns a summary and an entity share. A recurring parent has
+ * `repeat`; a draft it made has `repeat_from` and `issue_at`.
+ */
+export type DocumentSchedule = {
+    /** Set on a recurring parent only; null on every other document. */
+    repeat: DocumentRepeat | null;
+    /** The next issue date the parent drafts for (its draft is made three days before); null once ended. */
+    repeat_next_at: string | null;
+    /** The last date a draft may be issued on; null runs on. */
+    repeat_until: string | null;
+    repeat_paused: boolean;
+    /** On a draft the cron made: the parent it came from. */
+    repeat_from: DocumentIdentity | null;
+    /** A draft the cron issues and sends on this date (YYYY-MM-DD, Africa/Johannesburg). */
+    issue_at: string | null;
+};
+export type DocumentSummary = DocumentSchedule & {
+    mms_id: UUID;
+    created_at: Date;
+    title: string;
+    category: string;
+    status: DocumentStatus;
+    /** What prints, e.g. INV-0042; null until issued. */
+    number: string | null;
+    client: ClientIdentity | null;
+    /** Null when the document has no line items. */
+    currency: string | null;
+    total_minor: number;
+    issued_at: Date | null;
+    visibility: DocumentVisibility;
+    /** Null unless issued with a total above zero; then unpaid, paid or paid twice. */
+    payment_status: DocumentPaymentStatus | null;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
+};
+/**
+ * A document is its blocks plus its values: printing always combines the two the same way.
+ * A draft is edited freely; issuing gives it a number, freezes the system variables into
+ * `variable_values`, and it never changes again - it can only be voided.
+ */
+export type DocumentEntity = DocumentSchedule & {
+    mms_id: UUID;
+    created_at: Date;
+    created_by: UserIdentity | null;
+    updated_at: Date | null;
+    last_updated_by: UserIdentity | null;
+    /** The template it was made from; null for a blank document or once that template is deleted. */
+    template: DocumentTemplateIdentity | null;
+    client: ClientIdentity | null;
+    category: string;
+    title: string;
+    status: DocumentStatus;
+    number_prefix: string;
+    number: string | null;
+    currency: string | null;
+    /** The definitions copied from the template, so a later template edit cannot break a draft. */
+    variables: DocumentVariable[];
+    variable_values: DocumentVariableValues;
+    blocks: DocumentBlock[];
+    blocks_version: number;
+    /** Worked out from the line items blocks; all zero for a document without any. */
+    subtotal_minor: number;
+    discount_minor: number;
+    tax_minor: number;
+    total_minor: number;
+    issued_at: Date | null;
+    issued_by: UserIdentity | null;
+    voided_at: Date | null;
+    voided_by: UserIdentity | null;
+    void_reason: string | null;
+    visibility: DocumentVisibility;
+    /**
+     * The money received for it, oldest first: empty while unpaid, one payment once paid in full,
+     * two when two people paid at once (the owner refunds one). Read by the api beside the document.
+     */
+    payments: Payment[];
+    /** The same as on the summary, from `payments`. */
+    payment_status: DocumentPaymentStatus | null;
+    /** What the cron sends it in; null when there is none. */
+    email: DocumentEmail | null;
+    /** On a recurring parent: how many drafts it has made; null on every other document. */
+    issued_count: number | null;
+    /**
+     * Whether a send may carry Pay now, worked out by the api: in rands, a total above zero, not
+     * void, no payment yet, and the organization's payouts set up. On a draft: once it is issued.
+     * The send form starts with Pay now on when this is true.
+     */
+    pay_now_available: boolean;
+    /**
+     * What the caller may do with it, worked out by the api: the creator and an admin share are
+     * ADMIN; on an organization-visible record it follows the documents permissions.
+     */
+    my_role: VisibilityRole;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
+};
+/**
+ * One email a document went out in, newest first on `GET /documents/:id/sends` - read from the
+ * document's history, where each send is an audit event (`AuditTrailAction.SEND`).
+ */
+export type DocumentSend = {
+    mms_id: UUID;
+    created_at: Date;
+    created_by: UserIdentity | null;
+    recipients: string[];
+    cc: string[];
+    /** As sent, its variables filled in. */
+    subject: string;
+    /** Whether the email carried the pay link. */
+    pay_now: boolean;
+};
+/** What the public pay page shows - nothing that is not on the PDF itself, bar how to reach the sender. */
+export type PublicDocumentPayment = {
+    organization_name: string;
+    /** Where the client's questions go; null when the organization has none on file. */
+    organization_email: string | null;
+    organization_phone: string | null;
+    title: string;
+    number: string;
+    /** The date it was issued, YYYY-MM-DD, as frozen on it. */
+    issue_date: string | null;
+    /** Who it is billed to; null without a client. */
+    client_name: string | null;
+    /** Integer cents. Subtotal and tax are null when the document has no line items. */
+    subtotal_minor: number | null;
+    tax_minor: number | null;
+    total_minor: number;
+    currency: string | null;
+    status: DocumentPayStatus;
+    /** Prefills the payer's email; null when the document has no client email. */
+    client_email: string | null;
+};
+/** Where the payer goes next: Paystack's hosted checkout. */
+export type DocumentCheckout = {
+    authorization_url: string;
+};
+/** One side of a recorded change: plain text, a number (money in integer cents), a flag, or nothing. */
+export type DocumentChangeValue = string | number | boolean | null;
+/**
+ * One printable part of a block before and after a save, stored whole however long it is.
+ * `path` says where in the block it sits: the block's property, then for a list the entry's
+ * 0-based index (in the newer list; in the older one for an entry that was removed), then the
+ * entry's property or, in a table row, the cell's 0-based column:
+ *
+ *   ['content']                  a text block's text, as plain text with `{{key}}` for variables
+ *   ['fields', 1, 'value']       a fields block's second value
+ *   ['items', 0, 'quantity']     a line's quantity (`unit_price_minor` in cents; a variable amount as `{{key}}`)
+ *   ['columns', 2]               a table's third column heading
+ *   ['rows', 0, 3]               a table's first row, fourth cell
+ *   ['columns', 0, 'heading']    a columns block's first heading (`text` for its text)
+ *   ['signers', 1, 'label']      a signature block's second signer
+ *   ['left'], ['right']          a header's or footer's sides
+ *   ['alt'], ['path']            an image's alt text and file
+ */
+export type DocumentBlockPartChange = {
+    path: (string | number)[];
+    old: DocumentChangeValue;
+    new: DocumentChangeValue;
+};
+/**
+ * One block a save touched. `from` and `to` are 1-based places in the list before and after
+ * (null on the side it was not in). An added block lists every part it holds with `old: null`;
+ * a removed one every part with `new: null`; a moved one no parts; a changed one the parts that
+ * changed, and its `from` and `to` differ when it also moved. A block that only shifted because
+ * another was added or removed above it is not recorded.
+ */
+export type DocumentBlockChange = {
+    id: string;
+    type: DocumentBlockType;
+    kind: DocumentChangeKind;
+    from: number | null;
+    to: number | null;
+    parts: DocumentBlockPartChange[];
+};
+/**
+ * One variable definition a save touched, by key. `label` is its label now (as it was, when
+ * removed). An added variable lists every property with `old: null`, a removed one with
+ * `new: null`, a changed one the properties that changed. Order changes are not recorded.
+ */
+export type DocumentVariableChange = {
+    key: string;
+    label: string;
+    kind: DocumentChangeKind;
+    parts: {
+        field: 'label' | 'type' | 'required' | 'default_value';
+        old: DocumentChangeValue;
+        new: DocumentChangeValue;
+    }[];
+};
+/**
+ * One filled-in value a save changed, by key, with the variable's label and type at the time
+ * (both null for a system variable frozen at issue). Money is integer cents, a date YYYY-MM-DD.
+ */
+export type DocumentValueChange = {
+    key: string;
+    label: string | null;
+    type: DocumentVariableType | null;
+    old: DocumentVariableValue | null;
+    new: DocumentVariableValue | null;
+};
+export {};

package/dist/documents/index.js

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

package/dist/leads/index.d.ts

@@ -61,4 +61,6 @@ export type LeadEntity = {
     deleted_by: UserIdentity | null;
     restored_at: Date | null;
     restored_by: UserIdentity | null;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
 };

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

@@ -21,6 +21,10 @@ export declare enum NotificationType {
     TIMESHEET_SUBMITTED = "timesheet_submitted",
     TIMESHEET_APPROVED = "timesheet_approved",
     TIMESHEET_REJECTED = "timesheet_rejected",
+    DOCUMENT_PAID = "document_paid",
+    DOCUMENT_DRAFT_READY = "document_draft_ready",
+    DOCUMENT_ISSUED_AUTOMATICALLY = "document_issued_automatically",
+    DOCUMENT_ISSUE_FAILED = "document_issue_failed",
     SIGNUP_CONFIRMATION = "signup_confirmation",
     PASSWORD_RECOVERY = "password_recovery"
 }

package/dist/notifications/enum/index.js

@@ -29,6 +29,10 @@ var NotificationType;
     NotificationType["TIMESHEET_SUBMITTED"] = "timesheet_submitted";
     NotificationType["TIMESHEET_APPROVED"] = "timesheet_approved";
     NotificationType["TIMESHEET_REJECTED"] = "timesheet_rejected";
+    NotificationType["DOCUMENT_PAID"] = "document_paid";
+    NotificationType["DOCUMENT_DRAFT_READY"] = "document_draft_ready";
+    NotificationType["DOCUMENT_ISSUED_AUTOMATICALLY"] = "document_issued_automatically";
+    NotificationType["DOCUMENT_ISSUE_FAILED"] = "document_issue_failed";
     NotificationType["SIGNUP_CONFIRMATION"] = "signup_confirmation";
     NotificationType["PASSWORD_RECOVERY"] = "password_recovery";
 })(NotificationType || (exports.NotificationType = NotificationType = {}));

package/dist/organization/payouts/dto/index.d.ts

@@ -0,0 +1,15 @@
+import { PayoutAccountType, PayoutDocumentType } from '../enum';
+/**
+ * Sets up payouts, or changes the account: Paystack checks the account against the holder's
+ * identity document first, then the organization's subaccount is created or updated.
+ */
+export type UpdateOrganizationPayoutsDto = {
+    /** The account holder's name as the bank has it; also the name Paystack settles under. */
+    business_name: string;
+    account_type: PayoutAccountType;
+    /** A `PayoutBank.code`. */
+    bank_code: string;
+    account_number: string;
+    document_type: PayoutDocumentType;
+    document_number: string;
+};

package/dist/organization/payouts/dto/index.js

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

package/dist/organization/payouts/enum/index.d.ts

@@ -0,0 +1,11 @@
+/** Whose bank account the payouts go to, as Paystack's account check names it. */
+export declare enum PayoutAccountType {
+    PERSONAL = "personal",
+    BUSINESS = "business"
+}
+/** The identity document Paystack checks the account holder against. */
+export declare enum PayoutDocumentType {
+    IDENTITY_NUMBER = "identityNumber",
+    PASSPORT_NUMBER = "passportNumber",
+    BUSINESS_REGISTRATION_NUMBER = "businessRegistrationNumber"
+}

package/dist/organization/payouts/enum/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayoutDocumentType = exports.PayoutAccountType = void 0;
+/** Whose bank account the payouts go to, as Paystack's account check names it. */
+var PayoutAccountType;
+(function (PayoutAccountType) {
+    PayoutAccountType["PERSONAL"] = "personal";
+    PayoutAccountType["BUSINESS"] = "business";
+})(PayoutAccountType || (exports.PayoutAccountType = PayoutAccountType = {}));
+/** The identity document Paystack checks the account holder against. */
+var PayoutDocumentType;
+(function (PayoutDocumentType) {
+    PayoutDocumentType["IDENTITY_NUMBER"] = "identityNumber";
+    PayoutDocumentType["PASSPORT_NUMBER"] = "passportNumber";
+    PayoutDocumentType["BUSINESS_REGISTRATION_NUMBER"] = "businessRegistrationNumber";
+})(PayoutDocumentType || (exports.PayoutDocumentType = PayoutDocumentType = {}));

package/dist/organization/payouts/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Where an organization's Pay now money settles, as the organization page shows it: the bank
+ * and the account's last four digits, never the whole number. Pay now runs on the platform's
+ * Paystack account through a subaccount per organization; `enabled` is whether it has one.
+ */
+export type OrganizationPayouts = {
+    enabled: boolean;
+    business_name: string | null;
+    bank_name: string | null;
+    account_last4: string | null;
+    /**
+     * The platform's cut of each Pay now payment, in percent (0 when there is none) - on top of
+     * Paystack's own fee, which the organization bears. What the page says about fees reads this.
+     */
+    platform_fee_percent: number;
+};
+/** A South African bank payouts can settle to; `code` is what the form sends back. */
+export type PayoutBank = {
+    code: string;
+    name: string;
+};

package/dist/organization/payouts/index.js

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

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

@@ -0,0 +1,22 @@
+/** Which way the money went. Stored as plain text; TypeScript is the value set. */
+export declare enum PaymentDirection {
+    /** Received by the organization - a client paying a document. */
+    INCOMING = "incoming"
+}
+/** What a payment is for: the record's own table, as `payments.entity_type` stores it. */
+export declare enum PaymentEntityType {
+    DOCUMENTS = "documents"
+}
+/** How the money arrived. */
+export declare enum PaymentMethod {
+    /** Paystack checkout on the platform account, settled to the organization's subaccount. */
+    PAYSTACK = "paystack",
+    /** A bank transfer the organization received and marked paid by hand. */
+    EFT = "eft"
+}
+/** Where a payment is in its life. Stored as plain text. */
+export declare enum PaymentStatus {
+    /** A checkout is under way: every Pay now click reopens it until it is paid or fails. */
+    OPEN = "open",
+    PAID = "paid"
+}

package/dist/payments/enum/index.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentStatus = exports.PaymentMethod = exports.PaymentEntityType = exports.PaymentDirection = void 0;
+/** Which way the money went. Stored as plain text; TypeScript is the value set. */
+var PaymentDirection;
+(function (PaymentDirection) {
+    /** Received by the organization - a client paying a document. */
+    PaymentDirection["INCOMING"] = "incoming";
+})(PaymentDirection || (exports.PaymentDirection = PaymentDirection = {}));
+/** What a payment is for: the record's own table, as `payments.entity_type` stores it. */
+var PaymentEntityType;
+(function (PaymentEntityType) {
+    PaymentEntityType["DOCUMENTS"] = "documents";
+})(PaymentEntityType || (exports.PaymentEntityType = PaymentEntityType = {}));
+/** How the money arrived. */
+var PaymentMethod;
+(function (PaymentMethod) {
+    /** Paystack checkout on the platform account, settled to the organization's subaccount. */
+    PaymentMethod["PAYSTACK"] = "paystack";
+    /** A bank transfer the organization received and marked paid by hand. */
+    PaymentMethod["EFT"] = "eft";
+})(PaymentMethod || (exports.PaymentMethod = PaymentMethod = {}));
+/** Where a payment is in its life. Stored as plain text. */
+var PaymentStatus;
+(function (PaymentStatus) {
+    /** A checkout is under way: every Pay now click reopens it until it is paid or fails. */
+    PaymentStatus["OPEN"] = "open";
+    PaymentStatus["PAID"] = "paid";
+})(PaymentStatus || (exports.PaymentStatus = PaymentStatus = {}));

package/dist/payments/index.d.ts

@@ -0,0 +1,25 @@
+import type { UUID } from 'crypto';
+import type { UserIdentity } from '../users';
+import { PaymentDirection, PaymentMethod, PaymentStatus } from './enum';
+/**
+ * Money received for a record (a document, today), written by the api alone: an open Paystack
+ * checkout, then the settled payment - or an EFT the organization marked paid by hand. A second
+ * payment for the same record is a second row.
+ */
+export type Payment = {
+    mms_id: UUID;
+    created_at: Date;
+    /** Who marked it paid by hand; null for a payment Paystack settled. */
+    created_by: UserIdentity | null;
+    direction: PaymentDirection;
+    status: PaymentStatus;
+    /** Integer cents. */
+    amount_minor: number;
+    currency: string;
+    method: PaymentMethod;
+    /** Paystack's reference (unique), or the organization's own bank reference for an EFT. */
+    reference: string | null;
+    payer_email: string | null;
+    /** Null while open. */
+    paid_at: Date | null;
+};

package/dist/payments/index.js

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

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

@@ -37,3 +37,11 @@ export declare enum PaystackTransactionStatus {
     SEND_OTP = "send_otp",
     ABANDONED = "abandoned"
 }
+/**
+ * What a charge the api initialized is for, carried as `metadata.kind`. Subscription charges
+ * carry `transactionId` instead.
+ */
+export declare enum PaystackChargeKind {
+    /** A document's Pay now checkout, settled to the organization's subaccount. */
+    DOCUMENT_PAYMENT = "document_payment"
+}

package/dist/paystack/enum/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaystackTransactionStatus = exports.PaystackSubscriptionStatus = exports.PaystackWebhookEvent = void 0;
+exports.PaystackChargeKind = exports.PaystackTransactionStatus = exports.PaystackSubscriptionStatus = exports.PaystackWebhookEvent = void 0;
 var PaystackWebhookEvent;
 (function (PaystackWebhookEvent) {
     PaystackWebhookEvent["INVOICE_CREATED"] = "invoice.create";
@@ -46,3 +46,13 @@ var PaystackTransactionStatus;
     PaystackTransactionStatus["ABANDONED"] = "abandoned";
 })(PaystackTransactionStatus || (exports.PaystackTransactionStatus = PaystackTransactionStatus = {}));
 ;
+/**
+ * What a charge the api initialized is for, carried as `metadata.kind`. Subscription charges
+ * carry `transactionId` instead.
+ */
+var PaystackChargeKind;
+(function (PaystackChargeKind) {
+    /** A document's Pay now checkout, settled to the organization's subaccount. */
+    PaystackChargeKind["DOCUMENT_PAYMENT"] = "document_payment";
+})(PaystackChargeKind || (exports.PaystackChargeKind = PaystackChargeKind = {}));
+;