# freehelpdesk_api

> FreeHelpDesk API v1

Latest version **1.0.0** (published 2019-08-01) · Internal Use Only license · 0 weekly downloads

## Install

```sh
npm install freehelpdesk_api
pnpm add freehelpdesk_api
yarn add freehelpdesk_api
bun add freehelpdesk_api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-08-01 |
| First published | 2019-08-01 |
| Weekly downloads | 0 |
| License | Internal Use Only |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 64 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | freehelpdesk |

## Links

- npm: https://www.npmjs.com/package/freehelpdesk_api
- npm.io page: https://npm.io/package/freehelpdesk_api

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) 3.7.0

## Recent versions

- 1.0.0 (latest) — 2019-08-01

## README

# free_help_desk_api

FreeHelpDeskApi - JavaScript client for free_help_desk_api
FreeHelpDesk API v1
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: v1
- Package version: v1
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install free_help_desk_api --save
```

##### 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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

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

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
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**](docs/AuthenticationApi.md#getBearerAuthToken) | **POST** /token | Authenticates provided credentials and returns an access token
*FreeHelpDeskApi.ValuesApi* | [**valuesDelete**](docs/ValuesApi.md#valuesDelete) | **DELETE** /api/Values/{id} | 
*FreeHelpDeskApi.ValuesApi* | [**valuesGet**](docs/ValuesApi.md#valuesGet) | **GET** /api/Values | 
*FreeHelpDeskApi.ValuesApi* | [**valuesGet_0**](docs/ValuesApi.md#valuesGet_0) | **GET** /api/Values/{id} | 
*FreeHelpDeskApi.ValuesApi* | [**valuesPost**](docs/ValuesApi.md#valuesPost) | **POST** /api/Values | 
*FreeHelpDeskApi.ValuesApi* | [**valuesPut**](docs/ValuesApi.md#valuesPut) | **PUT** /api/Values/{id} | 


## Documentation for Models

 - [FreeHelpDeskApi.InlineResponse200](docs/InlineResponse200.md)


## Documentation for Authorization


### Authorization

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header

---
_Source: https://npm.io/package/freehelpdesk_api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._