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

package/readme.wiki

@@ -0,0 +1,332 @@
+= FAMIS DB API =
+
+== Installation ==
+
+<code>npm install famis-db</code>
+
+== Usage ==
+
+<source lang="javascript">import FamisDb from 'famis-db'
+
+const famisdb = new FAMISDb({
+  host: 'localhost',
+  user: 'username',
+  password: 'password',
+  database: 'dbname',
+});</source>
+== Configuration ==
+
+<source lang="javascript">{
+  host: 'localhost',
+  user: 'username',
+  password: 'password',
+  database: 'dbname',
+}</source>
+* host = [<code>string</code>] host name of database server
+* user = [<code>string</code>] username to access database
+* password = [<code>string</code>] password to access database
+* database = [<code>string</code>] name of database
+
+== API ==
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+==== Table of Contents ====
+
+* [[#processinvoice|processInvoice]]
+** [[#parameters|Parameters]]
+* [[#getinvoicebyid|getInvoiceById]]
+** [[#parameters-1|Parameters]]
+* [[#getinvoicebyuid|getInvoiceByUid]]
+** [[#parameters-2|Parameters]]
+* [[#getinvoicebynumber|getInvoiceByNumber]]
+** [[#parameters-3|Parameters]]
+* [[#getinvoicesbyaccount|getInvoicesByAccount]]
+** [[#parameters-4|Parameters]]
+* [[#getallinvoices|getAllInvoices]]
+** [[#parameters-5|Parameters]]
+* [[#getlatestinvoices|getLatestInvoices]]
+* [[#getheldinvoices|getHeldInvoices]]
+* [[#searchinvoicesbynumber|searchInvoicesByNumber]]
+** [[#parameters-6|Parameters]]
+* [[#searchinvoicesbyfamis|searchInvoicesByFamis]]
+** [[#parameters-7|Parameters]]
+* [[#addinvoice|addInvoice]]
+** [[#parameters-8|Parameters]]
+* [[#updateinvoice|updateInvoice]]
+** [[#parameters-9|Parameters]]
+* [[#markinvoiced|markInvoiced]]
+** [[#parameters-10|Parameters]]
+* [[#getfundbyaccountnumber|getFundByAccountNumber]]
+** [[#parameters-11|Parameters]]
+* [[#searchfundbyaccountnumber|searchFundByAccountNumber]]
+** [[#parameters-12|Parameters]]
+* [[#getfundsbyuin|getFundsByUin]]
+** [[#parameters-13|Parameters]]
+* [[#getfundsbyresponsibleuin|getFundsByResponsibleUin]]
+** [[#parameters-14|Parameters]]
+* [[#getnextfamisinvoicenumber|getNextFAMISInvoiceNumber]]
+** [[#parameters-15|Parameters]]
+* [[#getexpensecode|getExpenseCode]]
+** [[#parameters-16|Parameters]]
+* [[#getcorebyaccount|getCoreByAccount]]
+** [[#parameters-17|Parameters]]
+* [[#getsystembyid|getSystemById]]
+** [[#parameters-18|Parameters]]
+* [[#getusercores|getUserCores]]
+** [[#parameters-19|Parameters]]
+* [[#getusersystemparts|getUserSystemParts]]
+** [[#parameters-20|Parameters]]
+* [[#getuser|getUser]]
+** [[#parameters-21|Parameters]]
+* [[#getcustomernumber|getCustomerNumber]]
+** [[#parameters-22|Parameters]]
+
+=== processInvoice ===
+
+Process an invoice to have all necessary relationships
+
+==== Parameters ====
+
+* <code>invoice</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' invoice object
+
+=== getInvoiceById ===
+
+Get invoice by id
+
+==== Parameters ====
+
+* <code>id</code> '''nhumber'''
+
+Returns '''any''' object&gt;} invoice object
+
+=== getInvoiceByUid ===
+
+Get invoice by uid
+
+==== Parameters ====
+
+* <code>uid</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' invoice object
+
+=== getInvoiceByNumber ===
+
+Get invoice by originating system assigned number
+
+==== Parameters ====
+
+* <code>number</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' invoice object
+
+=== getInvoicesByAccount ===
+
+Get all invoices associated with a specified account number
+
+==== Parameters ====
+
+* <code>accountNumber</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array array]&gt;''' invoice objects
+
+=== getAllInvoices ===
+
+Get all invoice ordered by and sorted by paramaters passed
+
+==== Parameters ====
+
+* <code>orderBy</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]''' (optional, default <code>'date'</code>)
+* <code>dir</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]''' (optional, default <code>'desc'</code>)
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array array]&gt;''' invoice objects
+
+=== getLatestInvoices ===
+
+Retreives invoices from the latest date
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array array]&gt;''' invoice objects
+
+=== getHeldInvoices ===
+
+Returns all held invoices
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array array]&gt;''' held invoice objects
+
+=== searchInvoicesByNumber ===
+
+Search invoices by originating system generated invoice number
+
+==== Parameters ====
+
+* <code>number</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array array]&gt;''' invoice objects
+
+=== searchInvoicesByFamis ===
+
+Search invoices by FAMIS invoice number
+
+==== Parameters ====
+
+* <code>famis</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array array]&gt;''' invoice objects
+
+=== addInvoice ===
+
+Adds an invoice
+
+==== Parameters ====
+
+* <code>invoice</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]'''
+* <code>type</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+* <code>famisInvoiceNumber</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' invoice
+
+=== updateInvoice ===
+
+Updates an invoice
+
+==== Parameters ====
+
+* <code>id</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number number]'''
+* <code>invoice</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' invoice object
+
+=== markInvoiced ===
+
+Toggles an invoice as paid
+
+==== Parameters ====
+
+* <code>id</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number number]'''
+* <code>invoiced</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean boolean]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' invoice object
+
+=== getFundByAccountNumber ===
+
+Get PI funds by account number
+
+==== Parameters ====
+
+* <code>number</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' fund object
+
+=== searchFundByAccountNumber ===
+
+Search PI funds by partial account number
+
+==== Parameters ====
+
+* <code>number</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array array]&gt;''' fund object(s)
+
+=== getFundsByUin ===
+
+Get PI funds by UIN
+
+==== Parameters ====
+
+* <code>uin</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' fund object
+
+=== getFundsByResponsibleUin ===
+
+Get PI funds by responsible UIN
+
+==== Parameters ====
+
+* <code>uin</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array array]&gt;''' fund object(s)
+
+=== getNextFAMISInvoiceNumber ===
+
+Get next FAMIS invoice number in sequence for specified invoice type
+
+==== Parameters ====
+
+* <code>type</code><br />
+
+* <code>invoice</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]&gt;''' next invoice number in sequence
+
+=== getExpenseCode ===
+
+Get matching expense code for specified revenue code
+
+==== Parameters ====
+
+* <code>revenue</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]&gt;''' expense code
+
+=== getCoreByAccount ===
+
+Get core by account number
+
+==== Parameters ====
+
+* <code>account</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' core object
+
+=== getSystemById ===
+
+Get System part by ID
+
+==== Parameters ====
+
+* <code>id</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number number]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' system part object
+
+=== getUserCores ===
+
+Get a user's cores they manage
+
+==== Parameters ====
+
+* <code>userId</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array array]&gt;''' core objects
+
+=== getUserSystemParts ===
+
+Get a user's system parts they manage
+
+==== Parameters ====
+
+* <code>userId</code> '''any'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' system objects
+
+=== getUser ===
+
+Get user
+
+==== Parameters ====
+
+* <code>userId</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' user object
+
+=== getCustomerNumber ===
+
+Get customer a customer account
+
+==== Parameters ====
+
+* <code>accountNumber</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+* <code>campusCode</code> '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String string]'''
+
+Returns '''[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]&lt;[https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object object]&gt;''' customer account object