@veeroute/lss-account-javascript

@veeroute/lss-account-javascript

LssAccount - JavaScript client for @veeroute/lss-account-javascript Veeroute Account Panel This SDK is automatically generated by the OpenAPI Generator project:

• API version: 3.15.183137
• Package version: 3.15.183137
• 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 @veeroute/lss-account-javascript --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 @veeroute/lss-account-javascript 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 LssAccount = require('@veeroute/lss-account-javascript');

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

var api = new LssAccount.AuditApi()
var opts = {
  'offset': 10, // {Number} The number of items to skip before starting to collect the result set.
  'limit': 10, // {Number} The number of items to return.
  'from': 2021-02-21T09:30+03:00, // {Date} 
  'to': 2021-02-21T09:30+03:00, // {Date} 
  'serviceName': new LssAccount.ServiceName(), // {ServiceName} 
  'methodName': new LssAccount.MethodName() // {MethodName} 
};
api.readAccountAuditData(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://api.veeroute.tech/v3

Class	Method	HTTP request	Description
LssAccount.AuditApi	readAccountAuditData	GET /account/audit	User actions for the period.
LssAccount.AuthApi	changePassword	POST /account/password	Change password.
LssAccount.AuthApi	generateToken	POST /account/token	Obtaining a token.
LssAccount.AuthApi	validateToken	POST /account/token/validate	Validating a token.
LssAccount.DataApi	readAllDataXlsx	GET /account/data/xlsx/{tracecode}	Getting the data by `tracecode`.
LssAccount.DataApi	readInputData	GET /account/data/input/{tracecode}	Receiving an incoming request by `tracecode`.
LssAccount.DataApi	readOutputData	GET /account/data/output/{tracecode}	Getting the report result by `tracecode`.
LssAccount.InfoApi	readAccountInfo	GET /account/info	Getting a account information.
LssAccount.InfoApi	updateAccountInfo	PUT /account/info	Account update.
LssAccount.QuotaApi	readQuota	GET /account/quota	Obtaining the quotas.
LssAccount.ReportsApi	generateReport	POST /account/report	Reporting.
LssAccount.StatisticsApi	generateStatistics	POST /account/statistics	User statistics for the period.
LssAccount.SystemApi	check	GET /account/check	Checking the service availability.
LssAccount.SystemApi	version	GET /account/version	Getting the service version.

Documentation for Models

• LssAccount.AccountAction
• LssAccount.AccountInfo
• LssAccount.AdditionalQuota
• LssAccount.AuditStats
• LssAccount.CheckResult
• LssAccount.DateStatistics
• LssAccount.DateWindow
• LssAccount.DetailedAuditStats
• LssAccount.InlineResponse400
• LssAccount.InlineResponse400Validations
• LssAccount.InlineResponse401
• LssAccount.InlineResponse403
• LssAccount.InlineResponse404
• LssAccount.InlineResponse405
• LssAccount.InlineResponse406
• LssAccount.InlineResponse415
• LssAccount.InlineResponse429
• LssAccount.InlineResponse500
• LssAccount.InlineResponse501
• LssAccount.InlineResponse502
• LssAccount.InlineResponse503
• LssAccount.InlineResponse504
• LssAccount.InlineResponseDefault
• LssAccount.MethodName
• LssAccount.MethodQuota
• LssAccount.MethodStatistics
• LssAccount.PasswordRequest
• LssAccount.Quota
• LssAccount.ServiceName
• LssAccount.ServiceQuota
• LssAccount.ServiceStatistics
• LssAccount.TokenRequest
• LssAccount.TokenValidation
• LssAccount.TraceData
• LssAccount.UserActionDetail
• LssAccount.UserAuditResult
• LssAccount.UserQuotaResult
• LssAccount.UserReportFilter
• LssAccount.UserStatistics
• LssAccount.UserStatisticsFilter
• LssAccount.VersionResult

Documentation for Authorization

ApiKeyAuth

• Type: Bearer authentication (JWT)