encompassconnect
Version:
An Unofficial, (mostly) typed Node SDK that wraps around Ellie Mae's Encompass RESTful API.
25 lines (24 loc) • 971 B
TypeScript
import EncompassService from './service';
declare class SchemaService extends EncompassService {
/**
* Takes in a value representing key value pairs of field IDs and new values and returns the correct contract shape to perform an update on a loan.
*
* ```typescript
* const borrowerUpdateData = {
* '4000': 'new first name',
* '4002': 'new last name',
* };
*
* // returns the contract:
* const updateContract = await encompass.schemas.generateContract(borrowerUpdateData);
* // this value can now be used to update a loan:
* await encompass.loans.update(updateContract);
* ```
*/
generateContract(fields: any): Promise<any>;
/**
* Calls the loan schema endpoint and returns the schema. Can be filtered down by providing an optional array of entity names.
*/
getLoanSchema(entities?: string[]): Promise<any>;
}
export default SchemaService;