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

Finally, switch to the directory you want to use your free_help_desk_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('free_help_desk_api') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 FreeHelpDeskApi = require('free_help_desk_api');

var api = new FreeHelpDeskApi.AuthenticationApi()

var grantType = "password"; // {String} authorization grant type. (password/refresh_token)

var opts = { 
  'username': "username_example", // {String} Valid FreeHelpDesk username
  'password': "password_example", // {String} Valid FreeHelpDesk password
  'refreshToken': "refreshToken_example", // {String} Valid refresh token
  'type': "type_example" // {String} Login type (optional)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBearerAuthToken(grantType, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.freehelpdesk.com

Class	Method	HTTP request	Description
FreeHelpDeskApi.AuthenticationApi	getBearerAuthToken	POST /token	Authenticates provided credentials and returns an access token
FreeHelpDeskApi.ValuesApi	valuesDelete	DELETE /api/Values/{id}
FreeHelpDeskApi.ValuesApi	valuesGet	GET /api/Values
FreeHelpDeskApi.ValuesApi	valuesGet_0	GET /api/Values/{id}
FreeHelpDeskApi.ValuesApi	valuesPost	POST /api/Values
FreeHelpDeskApi.ValuesApi	valuesPut	PUT /api/Values/{id}

freehelpdesk_api