@tamu-dor/famis-db 3.0.0-beta.1

package/dist/index.d.ts

@@ -0,0 +1,1141 @@
+export declare interface Account {
+    uid: string;
+    account_number: string;
+    campus_code: string;
+    fiscal_year: number;
+    account: string;
+    support_account: string;
+    budget_support_account: string;
+    budget_account_number: string;
+    title: string | null;
+    expiration_date: Date | null;
+    status: string | null;
+    uin: string;
+    responsible_uin: string | null;
+    department: string | null;
+    setup_date: Date | null;
+    budget_access: string | null;
+    abr_rule: string;
+    idt_allowed: boolean | null;
+    adloc_campus_code: string | null;
+    adloc_department: string | null;
+    adloc_name: string | null;
+    preferred_first_name: string | null;
+    first_name: string | null;
+    middle_name: string | null;
+    last_name: string | null;
+    email: string | null;
+    work_phone: string | null;
+    active: boolean | null;
+    default_bank: string | null;
+    bank_override: boolean | null;
+    last_seen: Date | null;
+    srs: boolean | null;
+    cfda_no: string | null;
+    sponsor_type: string | null;
+}
+
+export declare interface AccountBalance {
+    account_number: string;
+    campus_code: string;
+    fiscal_year: number;
+    account: string;
+    support_account: string;
+    description?: string | null;
+    balance: number;
+}
+
+export declare interface AccountPayload {
+    data: Account[];
+    pagination: PageInfo;
+}
+
+export declare interface Contact {
+    fax: string | null;
+    city: string | null;
+    name: string;
+    email: string | null;
+    phone: string | null;
+    state: string | null;
+    country: string | null;
+    address1: string | null;
+    address2: string | null;
+    mailstop: string | null;
+    department: string | null;
+    postalCode: string | null;
+    institution: string | null;
+}
+
+export declare interface Core {
+    id: number;
+    account: string;
+    effective: string;
+    facility: string;
+    contact: string;
+    contactEmail: string;
+    systemId: number;
+    enabled: boolean;
+    deleted: string | null;
+    coreEmail: string;
+    corePhone: string | null;
+    coreAddress: string | null;
+    from_email: string | null;
+    invoice_email: string | null;
+    systemPart: SystemPart;
+    system_part?: string;
+    system_name?: string;
+    system_abbrev?: string;
+    users?: CoreUser[];
+    accounts?: CoreAccount[];
+}
+
+export declare interface CoreAccount {
+    id: number;
+    account: string;
+    coreId: number;
+    effective: Date;
+    active: boolean | null;
+}
+
+export declare interface CoreAccountEmail {
+    uid: string;
+    core_id: number;
+    account_number: string;
+    email: string;
+    created?: Date | null;
+    deleted?: Date | null;
+}
+
+export declare interface CorePayload {
+    data: Core[];
+    pagination: PageInfo;
+}
+
+export declare interface CoreUser {
+    id?: number;
+    userId: string;
+    coreId: number;
+    email?: boolean | null;
+}
+
+export declare interface CustomerAccountInfo {
+    uid: string;
+    account_number: string;
+    campus_code: string;
+    fiscal_year: number;
+    account: string;
+    support_account: string;
+    budget_support_account: string;
+    budget_account_number: string;
+    title: string;
+    expiration_date: string;
+    status: string;
+    uin: string;
+    responsible_uin: string;
+    department: string;
+    setup_date: string;
+    budget_access: string;
+    abr_rule: string;
+    idt_allowed: boolean;
+    adloc_campus_code: string;
+    adloc_department: string;
+    adloc_name: string;
+    preferred_first_name: string;
+    first_name: string;
+    middle_name: string | null;
+    last_name: string;
+    email: string;
+    work_phone: string;
+    active: boolean;
+    default_bank: string;
+    bank_override: boolean;
+    srs: boolean;
+    cfda_no: string;
+    sponsor_type: string;
+    billingEmailId: string;
+    parent_account_idt_allowed: boolean;
+}
+
+export declare interface Department {
+    part: string;
+    dept: string;
+    sub?: string | null;
+    dept_name: string;
+    dept_head?: string | null;
+    exec_level?: string | null;
+    division?: string | null;
+    school?: string | null;
+    exp_date?: Date | null;
+    idt_email?: string | null;
+    id?: string | null;
+}
+
+export declare interface Details {
+    ppu: number;
+    date: string;
+    famis: FamisDetails;
+    other: string;
+    amount: number;
+    status: string;
+    category: string;
+    comments: string | null;
+    quantity: number;
+    pmtNumber: string | null;
+    usageType: string;
+    itemComment: string | null;
+    customerName: string;
+    purchaseDate: string;
+    billingPeriod: string | null;
+    customerEmail: string;
+    customerTitle: string;
+    itemDescription: string;
+    sellingObjectCode: string;
+}
+
+export declare interface Edge {
+    cursor: string;
+    node: Invoice;
+}
+
+/**
+ * @typedef {Object} Account@typedef {Object} Account
+ * @property {string} uid
+ * @property {string} account_number
+ * @property {string} campus_code
+ * @property {number} fiscal_year
+ * @property {string} account
+ * @property {string} support_account
+ * @property {string} budget_support_account
+ * @property {string} budget_account_number
+ * @property {string | null} title
+ * @property {Date | null} expiration_date
+ * @property {string | null} status
+ * @property {string} uin
+ * @property {string | null} responsible_uin
+ * @property {string | null} department
+ * @property {Date | null} setup_date
+ * @property {string | null} budget_access
+ * @property {string} abr_rule
+ * @property {boolean | null} idt_allowed
+ * @property {string | null} adloc_campus_code
+ * @property {string | null} adloc_department
+ * @property {string | null} adloc_name
+ * @property {string | null} preferred_first_name
+ * @property {string | null} first_name
+ * @property {string | null} middle_name
+ * @property {string | null} last_name
+ * @property {string | null} email
+ * @property {string | null} work_phone
+ * @property {boolean | null} active
+ * @property {string | null} default_bank
+ * @property {boolean | null} bank_override
+ * @property {Date | null} last_seen
+ * @property {boolean | null} srs
+ * @property {string | null} cfda_no
+ * @property {string | null} sponsor_type
+ */
+/**
+ * Represents the Core schema.
+ * @typedef {Object} Core@typedef {Object} Core
+ * @property {number} id - The ID.
+ * @property {string} account - The account.
+ * @property {string} effective - The effective date.
+ * @property {string} facility - The facility.
+ * @property {string} contact - The contact.
+ * @property {string} contactEmail - The contact email.
+ * @property {number} systemId - The system ID.
+ * @property {boolean} enabled - Indicates if it's enabled.
+ * @property {string | null} deleted - The deletion status.
+ * @property {string} coreEmail - The core email.
+ * @property {string | null} corePhone - The core phone.
+ * @property {string | null} coreAddress - The core address.
+ * @property {string | null} from_email - The from email.
+ * @property {string | null} invoice_email - The invoice email.
+ * @property {Object} systemPart - The system part.
+ */
+/**
+ * @typedef {Object} Edge@typedef {Object} Edge
+ * @property {string} cursor - Description of the property.
+ * @property {InvoiceSchema} node - Description of the property.
+ */
+/**
+ * @typedef {Object} PageInfo@typedef {Object} PageInfo
+ * @property {boolean} hasNextPage - Description of the property.
+ * @property {boolean} hasPreviousPage - Description of the property.
+ * @property {string|null} [startCursor] - Description of the property.
+ * @property {string|null} [endCursor] - Description of the property.
+ */
+/**
+ * @typedef {Object} InvoicePayload@typedef {Object} InvoicePayload
+ * @property {Edge[]} edges - Description of the property.
+ * @property {PageInfo} pageInfo - Description of the property.
+ */
+/**
+ * @typedef {Object} CorePayload@typedef {Object} CorePayload
+ * @property {Edge[]} edges - Description of the property.
+ * @property {PageInfo} pageInfo - Description of the property.
+ */
+declare class FAMISDb {
+    private db;
+    private people;
+    constructor(config: any, people: any);
+    init(config: any, people: any): void;
+    /**
+     *
+     * Extract customer account and po number
+     * @param {object} famis
+     * @param {object} replace_data
+     * @returns {object} account number object
+     * @memberof FAMISDb
+     */
+    getAccountNumber(famis: {
+        customerAccountNumber: string;
+        customerPONumber: string;
+    }, replace_data?: {
+        customerAccountNumber?: string;
+        customerPONumber?: string;
+    }): {
+        accountNumber: string;
+        poNumber: string | null;
+    };
+    /**
+     *
+     * Process an invoice to have all necessary relationships
+     * @param {object} invoice - the invoice object sent by iLab
+     * @param {boolean} [historical=false] - if true use historical accounts too
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    processInvoice(invoice: any, historical?: boolean): Promise<any>;
+    /**
+     *
+     * Get invoice by uid
+     * @param {string} uid
+     * @param {string} [sortColumn='date']
+     * @param {string} [sortDirection='desc']
+     * @param {boolean} [deleted=false]
+     * @param {integer} page - page of results to return
+     * @param {string} perPage - number of results per page to return
+     * @returns {Promise<InvoicePayload>} invoice object
+     * @memberof FAMISDb
+     */
+    getInvoiceByUid(uid: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<InvoicePayload>;
+    /**
+     *
+     * Get invoice by originating system assigned number
+     * @param {string} number
+     * @param {string} [sortColumn='date']
+     * @param {string} [sortDirection='desc']
+     * @param {boolean} [deleted=false]
+     * @param {integer} page - page of results to return
+     * @param {string} perPage - number of results per page to return
+     * @returns {Promise<InvoicePayload>} invoice object
+     * @memberof FAMISDb
+     */
+    getInvoiceByNumber(number: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<InvoicePayload>;
+    /**
+     *
+     * Get invoice by fingerprint
+     * @param {string} fingerPrint
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    getInvoiceByFingerPrint(fingerPrint: string): Promise<any>;
+    /**
+     *
+     * Get all invoices associated with a specified account number
+     * @param {string} accountNumber
+     * @param {string} [sortColumn='date']
+     * @param {string} [sortDirection='desc']
+     * @param {boolean} [deleted=false]
+     * @param {integer} page - page of results to return
+     * @param {string} perPage - number of results per page to return
+     * @returns {Promise<InvoicePayload>} invoice objects
+     * @memberof FAMISDb
+     */
+    getInvoicesByAccount(accountNumber: string | string[], sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<InvoicePayload>;
+    /**
+     *
+     * Get all invoice ordered by and sorted by parameters passed
+     * @param {string} [sortColumn='date']
+     * @param {string} [sortDirection='desc']
+     * @param {boolean} [deleted=false]
+     * @param {integer} page - page of results to return
+     * @param {string} perPage - number of results per page to return
+     * @returns {Promise<InvoicePayload>} invoice objects
+     * @memberof FAMISDb
+     */
+    getAllInvoices(sortColumn?: string, sortDirection?: SortDirection | string, deleted?: boolean, page?: number, perPage?: number): Promise<InvoicePayload>;
+    /**
+     *
+     * Retrieves invoices from the latest date
+     * @param {string} [sortColumn='date']
+     * @param {string} [sortDirection='desc']
+     * @param {integer} first - corresponds to the first param of the Relay spec
+     * @param {string} after - corresponds to the after param of the Relay spec
+     * @param {integer} last - corresponds to the last param of the Relay spec
+     * @param {string} before - corresponds to the before param of the Relay spec
+     * @returns {Promise<InvoicePayload>} invoice objects
+     * @memberof FAMISDb
+     */
+    getLatestInvoices(sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<InvoicePayload>;
+    /**
+     *
+     * Returns all held invoices
+     * @param {string} [sortColumn='date']
+     * @param {string} [sortDirection='desc']
+     * @param {integer} page - corresponds to the first param of the Relay spec
+     * @param {integer} perPage - corresponds to the last param of the Relay spec
+     * @returns {Promise<InvoicePayload>} held invoice objects
+     * @memberof FAMISDb
+     */
+    getHeldInvoices(sortColumn?: string, sortDirection?: string, page?: number, perPage?: number): Promise<InvoicePayload>;
+    /**
+     *
+     * Returns all awaiting email invoices
+     * @param {string} [sortColumn='date']
+     * @param {string} [sortDirection='desc']
+     * @param {integer} first - corresponds to the first param of the Relay spec
+     * @param {string} after - corresponds to the after param of the Relay spec
+     * @param {integer} last - corresponds to the last param of the Relay spec
+     * @param {string} before - corresponds to the before param of the Relay spec
+     * @returns {Promise<InvoicePayload>} awaiting email invoice objects
+     * @memberof FAMISDb
+     */
+    getInvoicesAwaitingEmail(sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<InvoicePayload>;
+    /**
+     *
+     * Search invoices by originating system generated invoice number
+     * @param {string} number
+     * @param {string} [sortColumn='date']
+     * @param {string} [sortDirection='desc']
+     * @param {integer} first - corresponds to the first param of the Relay spec
+     * @param {string} after - corresponds to the after param of the Relay spec
+     * @param {integer} last - corresponds to the last param of the Relay spec
+     * @param {string} before - corresponds to the before param of the Relay spec
+     * @returns {Promise<InvoicePayload>} invoice objects
+     * @memberof FAMISDb
+     */
+    searchInvoicesByNumber(number: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<InvoicePayload>;
+    /**
+     *
+     * Search invoices by famis account number
+     * @param {string} account
+     * @param {string} [sortColumn='date']
+     * @param {string} [sortDirection='desc']
+     * @param {integer} first - corresponds to the first param of the Relay spec
+     * @param {string} after - corresponds to the after param of the Relay spec
+     * @param {integer} last - corresponds to the last param of the Relay spec
+     * @param {string} before - corresponds to the before param of the Relay spec
+     * @returns {Promise<InvoicePayload>} invoice objects
+     * @memberof FAMISDb
+     */
+    searchInvoicesByAccountNumber(account: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<InvoicePayload>;
+    /**
+     *
+     * Search invoices by FAMIS invoice number
+     * @param {string} famis
+     * @param {string} [sortColumn='date']
+     * @param {string} [sortDirection='desc']
+     * @param {integer} page - page of results to return
+     * @param {integer} perPage - number of results per page to return
+     * @returns {Promise<InvoicePayload>} invoice objects
+     * @memberof FAMISDb
+     */
+    searchInvoicesByFamis(famis: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<InvoicePayload>;
+    /**
+     *
+     * Queries invoices
+     * @param {string} query
+     * @param {string} [sortColumn='date']
+     * @param {string} [sortDirection='desc']
+     * @param {integer} page - page of results to return
+     * @param {integer} perPage - number of results per page to return
+     * @returns {Promise<InvoicePayload>} invoice objects
+     * @memberof FAMISDb
+     */
+    queryInvoices(query: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<InvoicePayload>;
+    /**
+     *
+     * Adds an invoice
+     * @param {object} invoice
+     * @param {string} type
+     * @param {string} famisInvoiceNumber
+     * @returns {Promise<object>} invoice
+     * @memberof FAMISDb
+     */
+    addInvoice(invoice: any, type: string, famisInvoiceNumber?: string): Promise<any>;
+    /**
+     *
+     * Updates an invoice
+     * @param {string} uid
+     * @param {object} invoice
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    updateInvoice(uid: string, invoice: any): Promise<any>;
+    /**
+     *
+     * Toggles an invoice as paid
+     * @param {string} uid
+     * @param {boolean} invoiced
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    markInvoiced(uid: string, invoiced: boolean): Promise<any>;
+    /**
+     *
+     * Toggles an invoice as emailed
+     * @param {string} uid
+     * @param {boolean} emailed
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    markEmailed(uid: string, emailed: boolean): Promise<any>;
+    /**
+     *
+     * Sets an invoice's deletion date
+     * @param {string} uid
+     * @param {date} deleted
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    setDeleted(uid: string, deleted: Date): Promise<any>;
+    /**
+     *
+     * Sets an invoice's posted date
+     * @param {string} uid
+     * @param {date} postedDate
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    setInvoicePostedDate(uid: string, postedDate: Date | null): Promise<any>;
+    /**
+     *
+     * Sets an invoice's fingerprint
+     * @param {string} uid
+     * @param {string} fingerprint
+     * @returns {Promise<object>} invoice object
+     * @memberof FAMISDb
+     */
+    setInvoiceFingerPrint(uid: string, fingerprint: string): Promise<any>;
+    /**
+     *
+     * Get PI accounts by account number
+     * @param {string} number
+     * @param {string} campus
+     * @param {boolean} [historical=false]
+     * @returns {Promise<Account>} account object
+     * @memberof FAMISDb
+     */
+    getByAccountNumber(number: string, campus?: string, historical?: boolean): Promise<any>;
+    /**
+     *
+     * Search PI accounts by partial account number
+     * @param {string|string[]} number
+     * @returns {Promise<AccountPayload>} account object(s)
+     * @memberof FAMISDb
+     */
+    searchByAccountNumber(number: string | string[], sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<AccountPayload>;
+    /**
+     *
+     * Get PI Accounts by UIN
+     * @param {string|string[]} uin
+     * @returns {Promise<Account[]>} account object array
+     * @memberof FAMISDb
+     */
+    getAccountsByUin(uin: string | string[], responsible?: boolean, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<AccountPayload>;
+    /**
+     *
+     * Get PI accounts by responsible UIN
+     * @param {string} uin
+     * @returns {Promise<Account[]>} account object array
+     * @memberof FAMISDb
+     */
+    getAccountsByResponsibleUin(uin: string | string[]): Promise<Account[]>;
+    /**
+     *
+     * Queries accounts
+     * @param {string} query
+     * @param {string} [sortColumn='date']
+     * @param {string} [sortDirection='desc']
+     * @param {integer} page - page of results to return
+     * @param {integer} perPage - number of results per page to return
+     * @returns {Promise<AccountPayload>} invoice objects
+     * @memberof FAMISDb
+     */
+    queryAccounts(query: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<AccountPayload>;
+    /**
+     *
+     * Get next FAMIS invoice number in sequence for specified invoice type
+     * @param {string} invoice
+     * @returns {Promise<string>} next invoice number in sequence
+     * @memberof FAMISDb
+     */
+    getNextFAMISInvoiceNumber(type: string): Promise<string>;
+    /**
+     *
+     * Get matching expense code for specified revenue code
+     * @param {string} revenue
+     * @returns {Promise<string>} expense code
+     * @memberof FAMISDb
+     */
+    getExpenseCodeByRevenue(revenue: string): Promise<string>;
+    /**
+     * Represents a row in the 'codes' table.
+     * @typedef {Object} Code@typedef {Object} Code
+     * @property {number} id - The unique identifier for the code.
+     * @property {string|null} revenue - The revenue code (nullable).
+     * @property {string|null} expense - The expense code (nullable).
+     * @property {boolean} sales - Indicates if the code is associated with sales.
+     * @property {boolean} srs - Indicates if the code is associated with SRS.
+     */
+    /**
+     *
+     * Get revenue code object
+     * @param {string} revenue
+     * @returns {Promise<Code>} revenue code object
+     * @memberof FAMISDb
+     */
+    getRevenueCode(revenue: string): Promise<FAMISObjectCode>;
+    /**
+     *
+     * Get expense code object
+     * @param {string} code
+     * @returns {Promise<Code>} expense code object
+     * @memberof FAMISDb
+     */
+    getExpenseCode(code: string): Promise<FAMISObjectCode>;
+    /**
+     *
+     * Check if expense code is within the allowable range for specified account and the specified fiscal year (defaults to the current)
+     * @param {string} accountNumber
+     * @param {string} code
+     * @param {integer} fiscal
+     * @returns {Promise<boolean>} truthy value
+     * @memberof FAMISDb
+     */
+    allowableExpenseCode(accountNumber: string, code: string, fiscal?: number): Promise<boolean>;
+    /**
+     *
+     * Get allowable expense code ranges for the specified account
+     * @param {string} accountNumber
+     * @param {integer} fiscal
+     * @returns {Promise<boolean>} expense code range object(s)
+     * @memberof FAMISDb
+     */
+    getAllowableExpenseCodes(accountNumber: string, fiscal?: number): Promise<{
+        allowed: object[];
+        disallowed: object[];
+    }>;
+    /**
+     *
+     * Query cores
+     * @param {string} query
+     * @param {string} [sortColumn='facility']
+     * @param {string} [sortDirection='asc']
+     * @param {integer} page - page of results to return
+     * @param {integer} perPage - number of results per page to return
+     * @returns {Promise<CorePayload>} core objects
+     * @memberof FAMISDb
+     */
+    queryCores(query: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<CorePayload>;
+    /**
+     *
+     * Get core by specified attribute and search term
+     * @param {string} type
+     * @param {string} operator
+     * @param {string} search
+     * @returns {Promise<Core>} core object
+     * @memberof FAMISDb
+     */
+    getCore(type: string, operator: string | undefined, search: string): Promise<Core>;
+    /**
+     *
+     * Get core by id
+     * @param {string} id
+     * @returns {Promise<Core>} core object
+     * @memberof FAMISDb
+     */
+    getCoreById(id: string): Promise<Core>;
+    /**
+     *
+     * Get core by account number
+     * @param {string} account
+     * @returns {Promise<Core>} core object
+     * @memberof FAMISDb
+     */
+    getCoreByAccount(account: string): Promise<Core>;
+    /**
+     *
+     * Update core
+     * @param {Core} core object
+     * @returns {Promise<Core>} core object
+     * @memberof FAMISDb
+     */
+    updateCore(core: Core): Promise<Core>;
+    /**
+     *
+     * Add core
+     * @param {Core} core object
+     * @returns {Promise<Core>} core object
+     * @memberof FAMISDb
+     */
+    addCore(core: Core): Promise<Core>;
+    /**
+     *
+     * Update core account
+     * @param {CoreAccount} account object
+     * @returns {Promise<CoreAccount>} core_account object
+     * @memberof FAMISDb
+     */
+    updateCoreAccount(account: CoreAccount): Promise<CoreAccount>;
+    /**
+     *
+     * Add core_account
+     * @param {CoreAccount} account object
+     * @returns {Promise<CoreAccount>} core_account object
+     * @memberof FAMISDb
+     */
+    addCoreAccount(account: CoreAccount): Promise<CoreAccount>;
+    /**
+     *
+     * Get system part by ID
+     * @param {number} id
+     * @returns {Promise<SystemPart>} system part object
+     * @memberof FAMISDb
+     */
+    getSystemById(id: number): Promise<SystemPart>;
+    /**
+     *
+     * Get system part by two-digit part number
+     * @param {string} number
+     * @returns {Promise<SystemPart>} system part object
+     * @memberof FAMISDb
+     */
+    getSystemByPartNumber(number: string): Promise<SystemPart>;
+    /**
+     *
+     * Get all enabled cores
+     * @returns {Promise<Core[]>} core objects
+     * @memberof FAMISDb
+     */
+    getEnabledCores(): Promise<Core[]>;
+    /**
+     *
+     * Get all cores
+     * @param {string} [sortColumn='facility']
+     * @param {string} [sortDirection='asc']
+     * @param {boolean} [deleted=false]
+     * @param {integer} page - page of results to return
+     * @param {string} perPage - number of results per page to return
+     * @returns {Promise<CorePayload>} core objects
+     * @memberof FAMISDb
+     */
+    getAllCores(sortColumn?: string, sortDirection?: SortDirection | string, deleted?: boolean, page?: number, perPage?: number): Promise<CorePayload>;
+    /**
+     *
+     * Get a core's users by core ID
+     * @param {number} coreId
+     * @returns {Promise<Core[]>} user objects
+     * @memberof FAMISDb
+     */
+    getCoreUsers(coreId: number): Promise<Core[]>;
+    /**
+     *
+     * Update core user
+     * @param {CoreUser} user object
+     * @returns {Promise<CoreUser>} user_core object
+     * @memberof FAMISDb
+     */
+    updateCoreUser(user: CoreUser): Promise<CoreUser>;
+    /**
+     *
+     * Add core user
+     * @param {CoreUser} coreUser core user object
+     * @param {User} user user object
+     * @returns {Promise<CoreUser>} core user object
+     * @memberof FAMISDb
+     */
+    addCoreUser(coreUser: CoreUser, user?: User): Promise<CoreUser>;
+    /**
+     *
+     * Get a user's cores they manage
+     * @param {string} userId
+     * @param {string} [sortColumn='facility']
+     * @param {string} [sortDirection='asc']
+     * @param {boolean} [deleted=false]
+     * @param {integer} page - page of results to return
+     * @param {string} perPage - number of results per page to return
+     * @returns {Promise<CorePayload]>} core objects
+         * @memberof FAMISDb
+         */
+     getUserCores(userId: string, sortColumn?: string, sortDirection?: SortDirection | string, deleted?: boolean, page?: number, perPage?: number): Promise<CorePayload>;
+     /**
+      *
+      * Get a system part's users by system ID
+      * @param {number} systemId
+      * @returns {Promise<object[]>} user objects
+      * @memberof FAMISDb
+      */
+     getSystemUsers(systemId: number): Promise<User[]>;
+     /**
+      *
+      * Get a user's system parts they manage
+      * @param {string} userId
+      * @returns {Promise<SystemPart[]>} system objects
+      * @memberof FAMISDb
+      */
+     getUserSystemParts(userId: string): Promise<SystemPart[]>;
+     /**
+      * Represents the "system" table in the public schema.
+      * @typedef {Object} System@typedef {Object} System
+      * @property {number} id - The ID (auto-generated).
+      * @property {string | null} name - The name.
+      * @property {string | null} due - The due text.
+      * @property {string | null} fein - The FEIN (Federal Employer Identification Number).
+      * @property {string | null} agency - The agency.
+      * @property {string | null} checkAddress - The check address.
+      * @property {boolean} credit - Indicates if credit is allowed.
+      * @property {string | null} creditUrl - The credit URL.
+      * @property {string | null} creditFee - The credit fee.
+      * @property {string | null} part - The part.
+      * @property {string | null} abbrev - The abbreviation.
+      * @property {string | null} aggiebuy - The AggieBuy information.
+      * @property {string | null} image - The image URL.
+      */
+     /**
+      * Get all system parts.
+      * @returns {Promise<SystemPart[]>} System objects.
+      * @memberof FAMISDb
+      */
+     getAllSystemParts(): Promise<SystemPart[]>;
+     /**
+      * Get all admin users.
+      * @returns {Promise<object[]>} Array of user objects.
+      * @memberof FAMISDb
+      */
+     getAdminUsers(): Promise<User[] | []>;
+     /**
+      * Get user.
+      * @param {string} userId - User ID.
+      * @returns {Promise<object>} User object.
+      * @memberof FAMISDb
+      */
+     getUser(userId: string): Promise<User | null>;
+     /**
+      * Update user.
+      * @param {object} user - User object.
+      * @returns {Promise<object>} Updated user object.
+      * @memberof FAMISDb
+      */
+     updateUser(user: object): Promise<object | null>;
+     /**
+      * Get customer by customer account number.
+      * @param {string} accountNumber - Customer account number.
+      * @param {string} campusCode - Campus code.
+      * @returns {Promise<object>} Customer account object.
+      * @memberof FAMISDb
+      */
+     getCustomerNumber(accountNumber: string, campusCode: string): Promise<object | null>;
+     /**
+      * Get current fiscal year.
+      * @returns {number} Fiscal year.
+      * @memberof FAMISDb
+      */
+     getCurrentFiscalYear(): number;
+     /**
+      * Return fingerprint of invoice.
+      * @param {object} invoice - JSON object.
+      * @returns {string} Fingerprint.
+      * @memberof FAMISDb
+      */
+     getInvoiceFingerPrint(invoice: object): string;
+     /**
+      * Return formatted account number.
+      * @param {string} accountNumber - Unformatted 13-digit FAMIS account number.
+      * @returns {string} Formatted 13-digit FAMIS account number.
+      * @memberof FAMISDb
+      */
+     formatAccountNumber(accountNumber: string): string;
+     /**
+      * Is invoice flagged by SRS high-risk policies.
+      * @param {object} invoice - JSON object.
+      * @returns {Promise<HighRisk>} High-risk object.
+      * @memberof FAMISDb
+      */
+     isSrsHighRisk(invoice: Invoice): Promise<HighRiskInfo>;
+     /**
+      * @typedef {Object} Comment@typedef {Object} Comment
+      * @property {integer} id - db generated id
+      * @property {string} uid - uid
+      * @property {string} invoice_id - invoice id
+      * @property {string} user_id - user uid
+      * @property {string} comment - text of comment
+      * @property {string} type - type of comment
+      * @property {date} created - created date
+      * @property {date} deleted - deleted date
+      */
+     /**
+      * Create or update an invoice comment.
+      * @param {Comment} comment - JSON object representing the comment
+      * @returns {Promise<Comment>} - Promise that resolves to the comment object
+      * @memberof FAMISDb
+      */
+     saveComment(comment: InvoiceComment): Promise<InvoiceComment | null>;
+     /**
+      * Get comments associated with an invoice.
+      * @param {string} invoiceUid - Invoice UID
+      * @returns {Promise<Comment[]>} - Promise that resolves to an array of comment objects
+      * @memberof FAMISDb
+      */
+     getInvoiceComments(invoiceUid: string): Promise<InvoiceComment[]>;
+     /**
+      * @typedef {Object} CommentFile@typedef {Object} CommentFile
+      * @property {integer} id - db generated id
+      * @property {string} uid - uid
+      * @property {string} invoice_id - invoice uid
+      * @property {string} comment_id - comment uid
+      * @property {string} original_filename - original file name
+      * @property {string} filename - generate unique filename on filesystem
+      * @property {date} created - created date
+      * @property {date} deleted - deleted date
+      */
+     /**
+      * Get invoice comment files.
+      * @param {string} commentUid - Comment UID
+      * @returns {Promise<CommentFile[]>} - Promise that resolves to an array of comment file objects
+      * @memberof FAMISDb
+      */
+     getCommentFiles(commentUid: string): Promise<InvoiceCommentFile[] | []>;
+     /**
+      * Get invoice comment file.
+      * @param {string} fileUid - File UID
+      * @returns {Promise<CommentFile>} - Promise that resolves to a comment file object
+      * @memberof FAMISDb
+      */
+     getCommentFile(fileUid: string): Promise<InvoiceCommentFile | null>;
+     /**
+      * Represents a row in the public.core_account_emails table.
+      *
+      * @interface CoreAccountEmail
+      * @property {string} uid - The unique identifier for the account email.
+      * @property {number} core_id - The core ID associated with the account email.
+      * @property {string} account_number - The account number associated with the email.
+      * @property {string} email - The email address associated with the account.
+      * @property {Date | null} [created] - The timestamp when the account email was created. Nullable.
+      * @property {Date | null} [deleted] - The timestamp when the account email was deleted. Nullable.
+      */
+     /**
+      * Get additional delivery email to an expense accounts by uid
+      * @param {string} uid - additional delivery email record uid
+      * @returns {Promise<CoreAccountEmail|null>} - Promise that resolves to an account object
+      * @memberof FAMISDb
+      */
+     getCoreAccountAdditionalEmailByUid(uid: string): Promise<CoreAccountEmail | null>;
+     /**
+      * Get additional delivery emails to expense accounts for a core by core id
+      * @param {number} coreId - Core ID
+      * @returns {Promise<CoreAccountEmail[]|[]>} - Promise that resolves to an account object
+      * @memberof FAMISDb
+      */
+     getCoreAccountAdditionalEmailsByCoreId(coreId: number): Promise<CoreAccountEmail[] | []>;
+     /**
+      * Get additional delivery emails to expense accounts for a core by account number
+      * @param {string} accountNumber - 13 digit famis account or customernumber
+      * @returns {Promise<CoreAccountEmail[]|[]>} - Promise that resolves to an account object
+      * @memberof FAMISDb
+      */
+     getCoreAccountAdditionalEmailsByAccount(accountNumber: string): Promise<CoreAccountEmail[] | []>;
+     /**
+      * Add an additional delivery email to an expense account for a core
+      * @param {string} accountNumber - 13 digit famis account or customernumber
+      * @param {number} coreId - Core ID
+      * @param {string} email - email address
+      * @returns {Promise<CoreAccountEmail>} - Promise that resolves to an account object
+      * @memberof FAMISDb
+      */
+     addCoreAccountAdditionalEmails(accountNumber: string, coreId: number, email: string): Promise<CoreAccountEmail | null>;
+     /**
+      * Remove an additional delivery email to an expense account for a core
+      * @param {string} uid - uid for core account email record
+      * @returns {Promise<CoreAccountEmail>} - Promise that resolves to an account object
+      * @memberof FAMISDb
+      */
+     removeCoreAccountAdditionalEmails(uid: string): Promise<CoreAccountEmail | null>;
+    }
+    export default FAMISDb;
+
+    export declare interface FamisDetails {
+        invoiceType: string;
+        invoiceNumber: string;
+        customerPONumber: string;
+        invoiceDepartment: string;
+        sellingCampusCode: string;
+        sellingAccountNumber: string;
+        customerAccountNumber: string;
+        sellingSupportAccount: string;
+    }
+
+    export declare type FAMISObjectCode = {
+        id: number;
+        revenue: string | null;
+        expense: string | null;
+        sales: boolean;
+        srs: boolean;
+    };
+
+    export declare interface HighRiskInfo {
+        isHighRisk: boolean;
+        flaggedTransactions: Details[];
+    }
+
+    export declare interface HighRiskTransaction {
+        [key: number]: Details[];
+    }
+
+    export declare interface Invoice {
+        uid: string;
+        number: string;
+        lab: string;
+        totalAmount: string;
+        date: string;
+        data: TransactionData;
+        invoiced: boolean;
+        type: string;
+        famisInvoiceNumber: string;
+        deleted: string | null;
+        customerAccount: string;
+        sellingAccount: string;
+        postedDate: string | null;
+        emailed: boolean;
+        replace_data?: object | null;
+        fingerprint: string;
+        core: Core;
+        customerAccountInfo: CustomerAccountInfo;
+        isIdt: boolean;
+        poNumber: string | null;
+        pi: PI;
+        highRiskInfo: HighRiskInfo;
+        comments: InvoiceComment[];
+    }
+
+    export declare interface InvoiceComment {
+        id?: number;
+        uid: string;
+        invoice_id: string;
+        user_id: string;
+        comment: string | null;
+        type: string | null;
+        created: string | null;
+        deleted: string | null;
+    }
+
+    export declare type InvoiceCommentFile = {
+        id: number;
+        uid: string;
+        invoice_id: string;
+        comment_id: string;
+        original_filename: string | null;
+        filename: string | null;
+        created: Date | null;
+        deleted: Date | null;
+    };
+
+    export declare interface InvoicePayload {
+        data: Invoice[];
+        pagination: PageInfo;
+    }
+
+    export declare interface IsHighRisk {
+        isHighRisk: boolean;
+        flaggedTransactions: Details[];
+    }
+
+    export declare interface PageInfo {
+        total?: number;
+        lastPage?: number;
+        currentPage: number;
+        perPage: number;
+        from: number;
+        to: number;
+    }
+
+    export declare interface PI {
+        tamuEduPersonUIN: string;
+        tamuEduPersonNetID: string | null;
+        uid: string;
+        sn: string;
+        givenName: string;
+        cn: string[];
+        displayName: string;
+        tamuEduPersonOfficialName: string;
+        mail: string;
+        postalAddress: string;
+        mailStop: string;
+        localityName: string;
+        stateOrProvinceName: string;
+        postalCode: string;
+        telephoneNumber: string;
+        title: string;
+        tamuEduPersonTitleCode: string;
+        tamuEduPersonDepartmentName: string;
+        tamuEduPersonPrimaryMember: string;
+        tamuEduPersonMember: string[];
+        tamuEduPersonPrimaryMemberName: string | null;
+        tamuEduPersonAffiliation: string[];
+        eduPersonOrcid: string | null;
+        tamuEduPersonAdLoc: string;
+        tamuEduPersonEmpLoc: string;
+        tamuEduDataFeed: string[];
+        tamuLastSeenTimestamp: string | null;
+        tamuEduPersonSupervisorUIN: string;
+        tamuManualAddRDN: string | null;
+    }
+
+    export declare type SortDirection = 'asc' | 'desc';
+
+    export declare interface SystemPart {
+        id: number;
+        name: string;
+        due: string;
+        fein: string;
+        agency: string;
+        checkAddress: string;
+        credit: boolean;
+        creditUrl: string;
+        creditFee: string;
+        part: string;
+        abbrev: string;
+        aggiebuy: string;
+        image: string;
+    }
+
+    export declare interface TransactionData {
+        to: Contact;
+        lab: string;
+        date: string;
+        from: Contact;
+        number: string;
+        details: Details[];
+        fingerprint: string;
+        totalAmount: string;
+    }
+
+    export declare type User = {
+        id?: number;
+        userId: string;
+        admin?: boolean;
+        role?: boolean;
+        roleName?: string | null;
+        roleEmail?: string | null;
+        email?: string | null;
+        usersSystemId?: number | null;
+        systemId?: number | null;
+        coreId?: number | null;
+        cores?: CorePayload | null;
+        systems?: SystemPart[] | [] | null;
+        deleted?: Date | null;
+    };
+
+    export { }