@lendertoolkit/encompass_api v1.0.56

encompass_api

EncompassApi - JavaScript client for encompass_api The oas spec for Encompass Developer Connect This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.56
• Package version: 1.0.56
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install encompass_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your encompass_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var EncompassApi = require('encompass_api');

var defaultClient = EncompassApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new EncompassApi.AuthApi()
var opts = {
  'grantType': "'password'", // {String} 
  'clientId': "clientId_example", // {String} 
  'clientSecret': "clientSecret_example", // {String} 
  'code': "code_example", // {String} 
  'username': "username_example", // {String} 
  'password': "password_example" // {String} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getToken(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.elliemae.com

Documentation for Models

• EncompassApi.All
• EncompassApi.Assignee
• EncompassApi.Association
• EncompassApi.CcSite
• EncompassApi.EllieMaeNetworkServiceCategories
• EncompassApi.EncompassV1LoansApplications
• EncompassApi.EncompassV1LoansBorrower
• EncompassApi.EncompassV1LoansEmployment
• EncompassApi.EncompassV1LoansIncome
• EncompassApi.EncompassV1LoansLoanIdApplications
• EncompassApi.EncompassV1LoansLoanIdBorrower
• EncompassApi.EncompassV1LoansLoanIdResidences
• EncompassApi.EncompassV1LoansResidences
• EncompassApi.EncompassV3LoanPipelineCanonicalFieldsOptions
• EncompassApi.EncompassV3LoanPipelineFields
• EncompassApi.EncompassV3LoanPipelineViewsPersona
• EncompassApi.EncompassV3LoansLoanIdDocumentsApplication
• EncompassApi.EncompassV3LoansLoanIdDocumentsApplication1
• EncompassApi.EncompassV3LoansLoanIdDocumentsCreatedBy
• EncompassApi.EncompassV3LoansLoanIdDocumentsCreatedBy1
• EncompassApi.EncompassV3LoansLoanIdDocumentsDocumentIdCommentsForRole
• EncompassApi.EncompassV3LoansLoanIdDocumentsRoles
• EncompassApi.FieldWriterContract
• EncompassApi.FieldWriterContractFields
• EncompassApi.GetAllSubtasks
• EncompassApi.GetAllTask
• EncompassApi.GetaUser
• EncompassApi.GetaUser2
• EncompassApi.Getusersassignedrights
• EncompassApi.Getuserseffectiverights
• EncompassApi.Getuserseffectiverights2
• EncompassApi.InlineObject
• EncompassApi.InlineObject1
• EncompassApi.InlineObject2
• EncompassApi.InlineObject3
• EncompassApi.InlineObject4
• EncompassApi.InlineResponse200
• EncompassApi.InlineResponse2001
• EncompassApi.InlineResponse20010
• EncompassApi.InlineResponse20011
• EncompassApi.InlineResponse20011Associations
• EncompassApi.InlineResponse20012
• EncompassApi.InlineResponse20012Associations
• EncompassApi.InlineResponse20012CustomAttributes
• EncompassApi.InlineResponse20012WorkEntity
• EncompassApi.InlineResponse20013
• EncompassApi.InlineResponse20013DispositionConfigurations
• EncompassApi.InlineResponse20013Dispositions
• EncompassApi.InlineResponse20013TaskTransitionConfiguration
• EncompassApi.InlineResponse20013VisibilityConfiguration
• EncompassApi.InlineResponse20014
• EncompassApi.InlineResponse20015
• EncompassApi.InlineResponse20016
• EncompassApi.InlineResponse20016Audit
• EncompassApi.InlineResponse20017
• EncompassApi.InlineResponse2002
• EncompassApi.InlineResponse2003
• EncompassApi.InlineResponse2004
• EncompassApi.InlineResponse2005
• EncompassApi.InlineResponse2006
• EncompassApi.InlineResponse2007
• EncompassApi.InlineResponse2007CreatedBy
• EncompassApi.InlineResponse2008
• EncompassApi.InlineResponse2009
• EncompassApi.InlineResponse201
• EncompassApi.InspectToken
• EncompassApi.ListUser
• EncompassApi.ListUsersusergroup
• EncompassApi.LoanPipelineQuery
• EncompassApi.LoanPipelineQueryFilter
• EncompassApi.LoanPipelineQuerySortOrder
• EncompassApi.ManageServiceProvidersList
• EncompassApi.Me
• EncompassApi.Metadata
• EncompassApi.None
• EncompassApi.Other
• EncompassApi.Persona
• EncompassApi.QueryTaskPipeline
• EncompassApi.TaskCommentContract
• EncompassApi.TaskCommentContractBody
• EncompassApi.TokenResponse
• EncompassApi.UnauthorizedBasic
• EncompassApi.WorkEntity

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication

httpBearer

• Type: Bearer authentication