encompassconnect
Version:
An Unofficial, (mostly) typed Node SDK that wraps around Ellie Mae's Encompass RESTful API.
42 lines (41 loc) • 1.7 kB
TypeScript
import EncompassService from './service';
import { AssignMilestoneOptions, UpdateMilestoneOptions } from '../types';
declare class MilestoneService extends EncompassService {
/**
* Returns the response of the Get All Milestone endpoints for the provided GUID.
*/
get(guid: string): Promise<any[]>;
/**
* Assigns a loan associate to a milestone. The associate ID provided must be of a user who fits the persona group for that milestone.
*
* ```typescript
* const guidToUpdate: string = 'some-loan-guid';
* const assignUnderwriterOptions: AssignMilestoneOptions = {
* loanGuid: guidToUpdate,
* milestone: 'Underwriting',
* userId: 'UnderwritersId',
* };
*
* await encompass.milestones.assign(assignUnderwriterOptions);
* ```
*/
assign({ milestone, userId, loanGuid, }: AssignMilestoneOptions): Promise<void>;
/**
* Updates the matching milestone for the loan guid provided. The `options` key will be added to the body of the call, and the optional `action` key can be used to finish or unfinish a milestone.
*
* ```typescript
* const updateProcessingOptions: UpdateMilestoneOptions = {
* loanGuid: guidToUpdate,
* milestone: 'Processing',
* options: {
* comments: 'this milestone is complete!',
* }
* action: 'finish',
* };
*
* await encompass.milestones.update(updateProcessingOptions);
* ```
*/
update({ loanGuid, milestone, options, action, }: UpdateMilestoneOptions): Promise<void>;
}
export default MilestoneService;