ecredit-direct-api

EcreditDirectApi - JavaScript client for ecredit-direct-api StitchCredit API This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.3
• 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 ecredit-direct-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 ecredit-direct-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 EcreditDirectApi = require('ecredit-direct-api');

var defaultClient = EcreditDirectApi.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: accessToken
var accessToken = defaultClient.authentications['accessToken'];
accessToken.accessToken = "YOUR ACCESS TOKEN"

var api = new EcreditDirectApi.DirectControllerApi()
var id = null; // {String} 
var DirectChangeEmailReqDTO = new EcreditDirectApi.DirectChangeEmailReqDTO(); // {DirectChangeEmailReqDTO} 
api.changeEmail(id, DirectChangeEmailReqDTO).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://efx-dev.stitchcredit.com/api

Class	Method	HTTP request	Description
EcreditDirectApi.DirectControllerApi	changeEmail	POST /direct/change-email/{id}
EcreditDirectApi.DirectControllerApi	changeHost	POST /direct/change-host/{id}
EcreditDirectApi.DirectControllerApi	changeMobile	POST /direct/change-mobile/{id}
EcreditDirectApi.DirectControllerApi	closeAccount	POST /direct/close-account/{id}
EcreditDirectApi.DirectControllerApi	efxAlert	GET /direct/efx-alert/{id}
EcreditDirectApi.DirectControllerApi	efxConfig	GET /direct/efx-config/{id}
EcreditDirectApi.DirectControllerApi	efxLatestEFXScore	GET /direct/efx-latest-efx-score/{id}
EcreditDirectApi.DirectControllerApi	efxLatestReport	GET /direct/efx-latest-report/{id}
EcreditDirectApi.DirectControllerApi	efxLatestScores	GET /direct/efx-latest-scores/{id}
EcreditDirectApi.DirectControllerApi	efxScoreHistory	GET /direct/efx-score-history/{id}
EcreditDirectApi.DirectControllerApi	efxScores	GET /direct/efx-scores/{id}
EcreditDirectApi.DirectControllerApi	getUser	GET /direct/user/{id}
EcreditDirectApi.DirectControllerApi	login	POST /direct/login
EcreditDirectApi.DirectControllerApi	preauthToken	GET /direct/preauth-token/{id}
EcreditDirectApi.DirectControllerApi	refreshToken	GET /direct/refresh-token
EcreditDirectApi.DirectControllerApi	register	POST /direct/user-reg
EcreditDirectApi.DirectControllerApi	registerOld	POST /direct/register
EcreditDirectApi.DirectControllerApi	updateRefresh	POST /direct/update-refresh/{id}
EcreditDirectApi.DirectControllerApi	userTokenOld	GET /direct/user-token/{id}

Documentation for Models

• EcreditDirectApi.AlertRespDTO
• EcreditDirectApi.BankruptcyReport
• EcreditDirectApi.CodeDescriptionReport
• EcreditDirectApi.CollectionItemReport
• EcreditDirectApi.ConsumerStatementReport
• EcreditDirectApi.ContactInformationReport
• EcreditDirectApi.CountryReport
• EcreditDirectApi.CreditReportAccountReport
• EcreditDirectApi.CreditReportProviderDisputeInformationReport
• EcreditDirectApi.CreditReportProviderViewReport
• EcreditDirectApi.CreditReportReport
• EcreditDirectApi.CreditReportSummaryAccountsReport
• EcreditDirectApi.CreditReportSummaryReport
• EcreditDirectApi.CreditScoreAbstractScore
• EcreditDirectApi.CreditScoreHistoryProviderViewScore
• EcreditDirectApi.CreditScoreHistoryScore
• EcreditDirectApi.CreditScoreLoanRiskRangeReport
• EcreditDirectApi.CreditScoreLoanRiskRangeScore
• EcreditDirectApi.CreditScoreProviderViewScore
• EcreditDirectApi.CreditScoreRangeReport
• EcreditDirectApi.CreditScoreRangeScore
• EcreditDirectApi.CreditScoreReasonReport
• EcreditDirectApi.CreditScoreReasonScore
• EcreditDirectApi.CreditScoreReport
• EcreditDirectApi.CreditScoreScore
• EcreditDirectApi.DirectChangeEmailReqDTO
• EcreditDirectApi.DirectChangeMobileReqDTO
• EcreditDirectApi.DirectLoginReqDTO
• EcreditDirectApi.DirectUserRegReqDTO
• EcreditDirectApi.EfxConfigRespDTO
• EcreditDirectApi.EmployerReport
• EcreditDirectApi.InquiryReport
• EcreditDirectApi.InternationalAddressReport
• EcreditDirectApi.InternationalPhoneReport
• EcreditDirectApi.JudgmentReport
• EcreditDirectApi.LienReport
• EcreditDirectApi.LoginRespDTO
• EcreditDirectApi.MoneyReport
• EcreditDirectApi.PaymentHistoryMonthReport
• EcreditDirectApi.PaymentHistoryYearReport
• EcreditDirectApi.PersonNameReport
• EcreditDirectApi.PersonSubjectReport
• EcreditDirectApi.PreauthTokenDTO
• EcreditDirectApi.PublicRecordsReport
• EcreditDirectApi.TrendedDataHistoryReport
• EcreditDirectApi.TrendedDataReport
• EcreditDirectApi.TrendedDataYearReport
• EcreditDirectApi.UserLoginRespDTO
• EcreditDirectApi.UserRespDTO

Documentation for Authorization

accessToken

• Type: Bearer authentication (JWT)