garoon
v0.3.2
Published
node library to access Garoon SOAP API.
Downloads
5
Readme
Node-Garoon
node library to access Cybozu Garoon SOAP API.
Features
- All garoon's remote procedure calls (RPC) are defined by
TypeScript
.- You can check inputs and outputs by type definitions.
- TypeScript 2.2 / ES2015
- All RPCs uses
Promise
for server response.
- All RPCs uses
Installation
via npm:
$ npm install --save garoon
For typescript project:
$ npm install --save garoon
$ npm install --save-dev @types/node
Example
JavaScript
const GaroonClient = require("garoon").Client;
const client = new GaroonClient({url: "http://example.com/grn.cgi?WSDL"});
// Use WSSecurity (Send username/password for each RPC method)
client.authenticate("username", "password");
client.UtilGetLoginUserId({}).then(response => {
console.log("user id is " + response.user_id);
});
TypeScript
import {Client as GaroonClient} from "garoon";
const client = new GaroonClient({url: "http://example.com/grn.cgi?WSDL"});
// Use WSSecurity (Send username/password for each RPC method)
client.authenticate("username", "password");
client.UtilGetLoginUserId({}).then(response => {
console.log("user id is " + response.user_id);
});
Test
Before run test, create auth file.
$ > testAuth.json
{
"url": "http://example.com/grn.cgi?WSDL",
"username": "foo",
"password": "bar"
}
Then, run all tests
$ yarn test
Or run specified tests
$ yarn test test/client.test.js
License
MIT