https://github.com/apocas/node-supportpal
Node.js client for SupportPal help desk.
https://github.com/apocas/node-supportpal
helpdesk nodejs supportpal
Last synced: 18 days ago
JSON representation
Node.js client for SupportPal help desk.
- Host: GitHub
- URL: https://github.com/apocas/node-supportpal
- Owner: apocas
- License: apache-2.0
- Created: 2020-06-23T01:44:14.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-23T19:07:04.000Z (almost 5 years ago)
- Last Synced: 2025-03-14T20:05:54.012Z (about 1 month ago)
- Topics: helpdesk, nodejs, supportpal
- Language: JavaScript
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-supportpal
Node.js client for [SupportPal](https://www.supportpal.com/) help desk.
## Installation
`npm install supportpal`
## Usage
* Check [SupportPal API documentation](https://api.supportpal.com/) for more details.
### Getting started
To use `supportpal` first you need to instantiate it:
``` js
var support = new Supportpal({ 'hostname': process.env.HOST, 'port': 443, 'hash': process.env.HASH });
```
### Creating a ticket
``` js
var opts = {
'subject': 'subject testtttt',
'text': 'text testtttttt',
'status': 1,
'priority': 1,
'department': 1,
'user_email': '[email protected]',
'user_firstname': 'Pedro',
'user_lastname': 'Dias'
};
support.ticket.create(opts, function(err, data) {
console.log(err)
console.log(data)
});
```
## Tests
* Tests are implemented using `mocha` and `chai`. Run them with `npm test`.
## Examples
Check the examples folder for more specific use cases examples.
## License
Pedro Dias - [@pedromdias](https://twitter.com/pedromdias)
Licensed under the Apache license, version 2.0 (the "license"); You may not use this file except in compliance with the license. You may obtain a copy of the license at:
http://www.apache.org/licenses/LICENSE-2.0.html
Unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an "as is" basis, without warranties or conditions of any kind, either express or implied. See the license for the specific language governing permissions and limitations under the license.