lib/client/board

board

Board - JavaScript client for board Taxnexus Onboarding Service This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.0.2
• Package version: 0.0.2
• 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 board --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 board 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 Board = require('board');


var api = new Board.CorsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.developerOptions(callback);

Documentation for API Endpoints

All URIs are relative to http://board.vernonkeenan.com:8080/v1

Class	Method	HTTP request	Description
Board.CorsApi	developerOptions	OPTIONS /developers
Board.CorsApi	iqOptions	OPTIONS /iqs
Board.CorsApi	leadsOptions	OPTIONS /leads
Board.CorsApi	userAuthOptions	OPTIONS /userauths
Board.CorsApi	userOptions	OPTIONS /users
Board.DevelopersApi	postDevelopers	POST /developers	Onboard new developer
Board.IqApi	postIQ	POST /iqs	Onboard new new Taxnexus IQ Customer
Board.LeadsApi	postLeads	POST /leads	Add a new Lead record
Board.LeadsApi	putLeads	PUT /leads	Update Leads
Board.UserAuthApi	getUserAuth	GET /userauths/{usernamePath}	Get a single UserAuth object
Board.UsersApi	getUsers	GET /users

Documentation for Models

• Board.Account
• Board.Address
• Board.Contact
• Board.Database
• Board.Developer
• Board.Error
• Board.IQ
• Board.Lead
• Board.PaymentMethod
• Board.Role
• Board.RuleExecution
• Board.Tenant
• Board.TenantUser
• Board.User
• Board.UserAuth
• Board.UserRole

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header