yl-third-party-loan-api-client

YlThirdPartyLoanApiClient - JavaScript client for yl-third-party-loan-api-client Through this API you can can retrieve loan data This SDK is automatically generated by the OpenAPI Generator project:

• API version: v1.0
• Package version: v1.0
• 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 yl-third-party-loan-api-client --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 yl-third-party-loan-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

The library is hosted at a git repository, e.g.https://github.com/YouLend/yl-third-party-loan-api-client.git then install it via:

    npm install YouLend/yl-third-party-loan-api-client --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 YlThirdPartyLoanApiClient = require('yl-third-party-loan-api-client');
 
var defaultClient = YlThirdPartyLoanApiClient.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"
 
var api = new YlThirdPartyLoanApiClient.LoansApi()
var customerId = "''"; // {String} Customer ID (a string)
var opts = {
  'apiVersion': "apiVersion_example" // {String} 
};
api.getAllLoans(customerId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});
 
 

Documentation for API Endpoints

All URIs are relative to https://staging.youlendapi.com/loan

Class	Method	HTTP request	Description
YlThirdPartyLoanApiClient.LoansApi	getAllLoans	GET /Loans/{customerId}/loans	Get all loans associated with your Customer ID
YlThirdPartyLoanApiClient.LoansApi	getLoan	GET /Loans/{loanId}	Get a specific loan by its Loan ID
YlThirdPartyLoanApiClient.LoansApi	getRepayments	GET /Loans/{loanId}/repayments	Get the repayment information associated with a given loan's Loan ID

Documentation for Models

• YlThirdPartyLoanApiClient.DefaultDetailsModel
• YlThirdPartyLoanApiClient.DocumentMetadataModel
• YlThirdPartyLoanApiClient.EarlyRenewalDetailsModel
• YlThirdPartyLoanApiClient.LoanDocumentModel
• YlThirdPartyLoanApiClient.LoanFundingDetailsModel
• YlThirdPartyLoanApiClient.LoanFundingPaymentModel
• YlThirdPartyLoanApiClient.LoanModel
• YlThirdPartyLoanApiClient.LoanOwnerModel
• YlThirdPartyLoanApiClient.LoanRefinancingDetailsModel
• YlThirdPartyLoanApiClient.LoanRepaymentModel
• YlThirdPartyLoanApiClient.LoanWriteOffDetailsModel
• YlThirdPartyLoanApiClient.LoansModel
• YlThirdPartyLoanApiClient.ProblemDetails
• YlThirdPartyLoanApiClient.RefinancingLoanDetailsModel
• YlThirdPartyLoanApiClient.ThirdPartyReferenceModel

Documentation for Authorization

oauth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A