❤
npm
Sign UpSign In

@lendertoolkit/encompass_api_browser

1.0.56 • Public • Published

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

Class Method HTTP request Description
EncompassApi.AuthApi getToken POST /oauth2/v1/token Get token with different grant types
EncompassApi.AuthApi inspectToken POST /oauth2/v1/token/introspection Inspect Token
EncompassApi.AuthApi revokeToken POST /oauth2/v1/token/revocation Revoke Token
EncompassApi.EFolderApi getDocumentList GET /encompass/v3/loans/{loanId}/documents Get List of Documents
EncompassApi.EFolderApi updateDocumentAttachment PATCH /encompass/v3/loans/{loanId}/documents/{documentId}/attachments Assign Document Attachments
EncompassApi.EFolderApi updateDocumentAttachmentComment PATCH /encompass/v3/loans/{loanId}/documents/{documentId}/comments Add Comments to a Document
EncompassApi.EFolderApi updateDocuments PATCH /encompass/v3/loans/{loanId}/documents Manage Documents
EncompassApi.LoanFolderApi getLoanFolder GET /encompass/v3/loanFolders/{folderName} Get a Loan Folder
EncompassApi.LoanFolderApi getLoanFolders GET /encompass/v3/loanFolders Get List of Loan Folders
EncompassApi.LoanManagementApi createLoan POST /encompass/v1/loans Create Loan
EncompassApi.LoanManagementApi deleteLoan DELETE /encompass/v1/loans/{loanId} Delete Loan
EncompassApi.LoanManagementApi fieldLockData PATCH /encompass/v3/loans/{loanId}/fieldLockData Field Lock Data
EncompassApi.LoanManagementApi fieldReader POST /encompass/v3/loans/{loanId}/fieldReader Field Reader
EncompassApi.LoanManagementApi fieldWriter POST /encompass/v3/loans/{loanId}/fieldWriter Field Writer
EncompassApi.LoanManagementApi getLoan GET /encompass/v1/loans/{loanId} Get Loan
EncompassApi.LoanManagementApi getLoanEntities GET /encompass/v1/loans/supportedEntities Get Supported Entities
EncompassApi.LoanManagementApi getLoanMetadata GET /encompass/v1/loans/{loanId}/metadata Get Loan Metadata
EncompassApi.LoanManagementApi getLoanObject GET /encompass/v3/loans/{loanId} Get Loan
EncompassApi.LoanManagementApi moveLoan PATCH /encompass/v1/loanfolders/{folderName}/loans Move Loan to Folder
EncompassApi.LoanManagementApi updateLoan PATCH /encompass/v1/loans/{loanId} Update Loan
EncompassApi.LoanPipelineApi getLoanPipelineCanonicalNames GET /encompass/v3/loanPipeline/canonicalFields Get Loan Pipeline Canonical Field Names
EncompassApi.LoanPipelineApi getLoanPipelineView GET /encompass/v3/loanPipeline/views/{view}/{viewId} View Pipeline
EncompassApi.LoanPipelineApi getPipelineViews GET /encompass/v3/loanPipeline/views Pipeline Views List
EncompassApi.LoanPipelineApi loanPipelineQuery POST /encompass/v3/loanPipeline Query Loan Pipeline
EncompassApi.SettingsApi getAllCustomFields GET /encompass/v1/settings/loan/customFields Get All Custom Fields
EncompassApi.SettingsApi getCustomField GET /encompass/v1/settings/loan/customFields/{customFieldId} Get a Custom Field
EncompassApi.SettingsApi getDocumentTemplates GET /encompass/v1/settings/efolder/documenttemplates Get All Document Placeholders
EncompassApi.SettingsApi getUserGroups GET /encompass/v1/settings/userGroups Get User Groups
EncompassApi.TasksApi addTaskComment POST /workflow/v1/tasks/{id}/comments Add a Comment to a Task
EncompassApi.TasksApi getAllTasks GET /workflow/v1/tasks Get All Tasks
EncompassApi.TasksApi getSubtasks GET /workflow/v1/tasks/{id}/subtasks Get Subtasks
EncompassApi.TasksApi getTask GET /workflow/v1/tasks/{id} Get A Task
EncompassApi.TasksApi getTaskComments GET /workflow/v1/tasks/{id}/comments Get Comments for a Task
EncompassApi.TasksApi getTaskSettings GET /workflow/v1/settings/task Get Task Settings
EncompassApi.TasksApi queryTaskPipeline GET /workflow/v1/taskPipeline Query Task Pipeline
EncompassApi.TasksApi updateTask PATCH /workflow/v1/tasks/{id} Update a Task
EncompassApi.UsersSettingsApi getUsersassignedrights GET /encompass/v1/company/users/{userId}/assignedRights Get Users assigned rights
EncompassApi.UsersSettingsApi getUserseffectiverights GET /encompass/v1/company/users/{userId}/effectiveRights Get Users effective rights
EncompassApi.UsersSettingsApi getaUser GET /encompass/v1/company/users/{smart_client_user} Get a User
EncompassApi.UsersSettingsApi listUsers GET /encompass/v1/company/users List Users
EncompassApi.UsersSettingsApi listUsersusergroups GET /encompass/v1/company/users/{smart_client_user}/groups List Users user groups
EncompassApi.UsersSettingsApi me GET /encompass/v1/company/users/me Me
EncompassApi.V1Api getUserGroups GET /encompass/v1/settings/userGroups Get User Groups
EncompassApi.V2Api addTaskComment POST /workflow/v1/tasks/{id}/comments Add a Comment to a Task
EncompassApi.V2Api createLoan POST /encompass/v1/loans Create Loan
EncompassApi.V2Api deleteLoan DELETE /encompass/v1/loans/{loanId} Delete Loan
EncompassApi.V2Api getAllCustomFields GET /encompass/v1/settings/loan/customFields Get All Custom Fields
EncompassApi.V2Api getAllTasks GET /workflow/v1/tasks Get All Tasks
EncompassApi.V2Api getCustomField GET /encompass/v1/settings/loan/customFields/{customFieldId} Get a Custom Field
EncompassApi.V2Api getDocumentTemplates GET /encompass/v1/settings/efolder/documenttemplates Get All Document Placeholders
EncompassApi.V2Api getLoan GET /encompass/v1/loans/{loanId} Get Loan
EncompassApi.V2Api getLoanEntities GET /encompass/v1/loans/supportedEntities Get Supported Entities
EncompassApi.V2Api getLoanMetadata GET /encompass/v1/loans/{loanId}/metadata Get Loan Metadata
EncompassApi.V2Api getSubtasks GET /workflow/v1/tasks/{id}/subtasks Get Subtasks
EncompassApi.V2Api getTask GET /workflow/v1/tasks/{id} Get A Task
EncompassApi.V2Api getTaskComments GET /workflow/v1/tasks/{id}/comments Get Comments for a Task
EncompassApi.V2Api getTaskSettings GET /workflow/v1/settings/task Get Task Settings
EncompassApi.V2Api getToken POST /oauth2/v1/token Get token with different grant types
EncompassApi.V2Api getUsersassignedrights GET /encompass/v1/company/users/{userId}/assignedRights Get Users assigned rights
EncompassApi.V2Api getUserseffectiverights GET /encompass/v1/company/users/{userId}/effectiveRights Get Users effective rights
EncompassApi.V2Api getaUser GET /encompass/v1/company/users/{smart_client_user} Get a User
EncompassApi.V2Api inspectToken POST /oauth2/v1/token/introspection Inspect Token
EncompassApi.V2Api listUsers GET /encompass/v1/company/users List Users
EncompassApi.V2Api listUsersusergroups GET /encompass/v1/company/users/{smart_client_user}/groups List Users user groups
EncompassApi.V2Api me GET /encompass/v1/company/users/me Me
EncompassApi.V2Api moveLoan PATCH /encompass/v1/loanfolders/{folderName}/loans Move Loan to Folder
EncompassApi.V2Api queryTaskPipeline GET /workflow/v1/taskPipeline Query Task Pipeline
EncompassApi.V2Api revokeToken POST /oauth2/v1/token/revocation Revoke Token
EncompassApi.V2Api updateLoan PATCH /encompass/v1/loans/{loanId} Update Loan
EncompassApi.V2Api updateTask PATCH /workflow/v1/tasks/{id} Update a Task
EncompassApi.V3Api fieldLockData PATCH /encompass/v3/loans/{loanId}/fieldLockData Field Lock Data
EncompassApi.V3Api fieldReader POST /encompass/v3/loans/{loanId}/fieldReader Field Reader
EncompassApi.V3Api fieldWriter POST /encompass/v3/loans/{loanId}/fieldWriter Field Writer
EncompassApi.V3Api getDocumentList GET /encompass/v3/loans/{loanId}/documents Get List of Documents
EncompassApi.V3Api getLoanFolder GET /encompass/v3/loanFolders/{folderName} Get a Loan Folder
EncompassApi.V3Api getLoanFolders GET /encompass/v3/loanFolders Get List of Loan Folders
EncompassApi.V3Api getLoanObject GET /encompass/v3/loans/{loanId} Get Loan
EncompassApi.V3Api getLoanPipelineCanonicalNames GET /encompass/v3/loanPipeline/canonicalFields Get Loan Pipeline Canonical Field Names
EncompassApi.V3Api getLoanPipelineView GET /encompass/v3/loanPipeline/views/{view}/{viewId} View Pipeline
EncompassApi.V3Api getPipelineViews GET /encompass/v3/loanPipeline/views Pipeline Views List
EncompassApi.V3Api loanPipelineQuery POST /encompass/v3/loanPipeline Query Loan Pipeline
EncompassApi.V3Api updateDocumentAttachment PATCH /encompass/v3/loans/{loanId}/documents/{documentId}/attachments Assign Document Attachments
EncompassApi.V3Api updateDocumentAttachmentComment PATCH /encompass/v3/loans/{loanId}/documents/{documentId}/comments Add Comments to a Document
EncompassApi.V3Api updateDocuments PATCH /encompass/v3/loans/{loanId}/documents Manage Documents

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication

httpBearer

  • Type: Bearer authentication

Readme

Keywords

none

Package Sidebar

Install

npm i @lendertoolkit/encompass_api_browser

Weekly Downloads

1

Version

1.0.56

License

Unlicense

Unpacked Size

1.27 MB

Total Files

4

Last publish

Collaborators

  • ltkdev
Try on RunKit
Report malware