givver_uk_payroll_api

GivverUkPayrollApi - JavaScript client for givver_uk_payroll_api The OpenAPI Specification for the Givver UK Payroll API This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.0.14-SNAPSHOT
• Package version: 0.0.14-SNAPSHOT
• 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 givver_uk_payroll_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 givver_uk_payroll_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 GivverUkPayrollApi = require('givver_uk_payroll_api');

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

var api = new GivverUkPayrollApi.CompanyApi()
var createCompanyRequest = new GivverUkPayrollApi.CreateCompanyRequest(); // {CreateCompanyRequest} The company to create
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createCompany(createCompanyRequest, callback);

Documentation for API Endpoints

All URIs are relative to https://api.givver.uk

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- GivverUkPayrollApi.CompanyApi | createCompany | POST /companies | Create a company GivverUkPayrollApi.CompanyApi | updateCompany | PUT /companies/{id} | Update a company GivverUkPayrollApi.EmployeeApi | createEmployee | POST /employees | Create an employee GivverUkPayrollApi.EmployeeApi | retrieveEmployee | GET /employees/{id} | Retrieve an employee

Documentation for Models

• GivverUkPayrollApi.CreateCompanyRequest
• GivverUkPayrollApi.Employee
• GivverUkPayrollApi.EmployeeAddress
• GivverUkPayrollApi.EmployeeName

Documentation for Authorization

bearerAuth

• Type: Bearer authentication