Awesome

node-sparky

Cisco Spark API for Node JS

This is a Cisco Spark API Library for Node JS. This project aims to simplify interaction with the Spark API while transparently handling more complex operations such as pagination, webhook creation, and webhook authentication. If you have a question, feature request, or have found a bug, please open an issue.

Quick Start

const Spark = require('node-sparky');

const spark = new Spark({ token: '<token>' });

spark.roomsGet(10)
  .then(rooms => rooms.forEach(room => console.log(room.title)))
  .catch(err => console.error(err));

Features

Rate limiting headers inspected to adjust request rates based on Cisco Spark API. These are automatically re-queued and sent after the retry-after timer expires.
File processor for retrieving attachments from room.
Returns promises that comply with A+ standards..
Handles pagination transparently. (Receive unlimited records)
Support for authenticated HMAC-SHA1 webhooks

Using node-sparky as a Node JS Package

This module can be installed via NPM:

npm install node-sparky --save

Using node-sparky webhook event parser in an Express App

const Spark = require('node-sparky');
const express = require('express');
const bodyParser = require('body-parser');
const when = require('when');

const spark = new Spark({
  token: '<my token>',
  webhookSecret: 'somesecr3t',
});

const port = parseInt(process.env.PORT || '3000', 10);

// add events
spark.on('messages-created', msg => console.log(`${msg.personEmail} said: ${msg.text}`));

const app = express();
app.use(bodyParser.json());

// add route for path that is listening for web hooks
app.post('/webhook', spark.webhookListen());

// start express server
app.listen(port, function() {
  // get exisiting webhooks
  spark.webhooksGet()
    // remove all existing webhooks
    .then(webhooks => when.map(webhooks, webhook => spark.webhookRemove(webhook.id)))
    // create spark webhook directed back to the externally accessible
    // express route defined above.
    .then(() => spark.webhookAdd({
      name: 'my webhook',
      targetUrl: 'https://example.com/webhook',
      resource: 'all',
      event: 'all',
    });
  console.log(`Listening on port ${port}`);
});

Using node-sparky in the Browser

You can use node-sparky on the client side browser as well. Simply include <script src="browser/node-sparky.js"></script> in your page and you can use node-sparky just as you can with with node-js.

<head>
    <title>test</title>
    <script src="https://code.jquery.com/jquery-3.2.1.min.js"></script>
    <script src="browser/node-sparky.js"></script>
</head>

<body>
    <h1>Test</h1>
    <div id="messageId"></div>

    <script>
        $(document).ready(function() {
            var spark = new Sparky({
                token: '<my token>'
            });

            var message = {
                roomId: '<room id>',
                text: 'Hello world!'
            };

            spark.messageSend(message)
                .then(function(res) {
                    $('#messageId').html(res.id);
                })
                .catch(function(err) {
                    console.log(err);
                });
        });
    </script>
</body>

</html>

Note: The above is a simple example. It is not recommended to include the token in anything client accessible. This would ideally be part of a broader application that makes use of oauth2 to cross authenticate the user to Spark to grab their token through a Spark integration should you use node-sparky in the browser side JS.

Contributing

Build

The README.md and browser/node-sparky.* files are auto-generated from the files in /lib and /docs. To regenerate these run:

npm run build

Test

Tests require a user token and will not fully run using a bot token. It is assumed that the user token has Org Admin permissions. If not, certain tests WILL fail. The tests can be run via:

git clone https://github.com/flint-bot/sparky
cd sparky
npm install
SPARKY_API_TOKEN=someUserTokenHere npm test

Support this Project

Find this project useful? Help suppport the continued development by submitting issues, feature requests, or code. Alternatively, you can...

Reference

Classes

<dl> <dt><a href="#Spark">Spark</a></dt> <dd></dd> </dl>

Objects

<dl> <dt><a href="#File">File</a> : <code>object</code></dt> <dd>File Object </dd> <dt><a href="#Event">Event</a> : <code>object</code></dt> <dd>Event Object </dd> <dt><a href="#License">License</a> : <code>object</code></dt> <dd>License Object </dd> <dt><a href="#Membership">Membership</a> : <code>object</code></dt> <dd>Membership Object </dd> <dt><a href="#Message">Message</a> : <code>object</code></dt> <dd>Message Object </dd> <dt><a href="#Organization">Organization</a> : <code>object</code></dt> <dd>Organization Object </dd> <dt><a href="#Person">Person</a> : <code>object</code></dt> <dd>Person Object </dd> <dt><a href="#Role">Role</a> : <code>object</code></dt> <dd>Role Object </dd> <dt><a href="#Room">Room</a> : <code>object</code></dt> <dd>Room Object </dd> <dt><a href="#Team">Team</a> : <code>object</code></dt> <dd>Team Object </dd> <dt><a href="#TeamMembership">TeamMembership</a> : <code>object</code></dt> <dd>Team Membership Object </dd> <dt><a href="#Webhook">Webhook</a> : <code>object</code></dt> <dd>Webhook Object </dd> <dt><a href="#Validator">Validator</a> : <code>object</code></dt> <dd>Spark Object Validation </dd> </dl>

Events

<dl> <dt><a href="#event_memberships">"memberships"</a></dt> <dd>Webhook membership event </dd> <dt><a href="#event_messages">"messages"</a></dt> <dd>Webhook messages event </dd> <dt><a href="#event_rooms">"rooms"</a></dt> <dd>Webhook rooms event </dd> <dt><a href="#event_memberships-created">"memberships-created"</a></dt> <dd>Webhook Memberships Created event </dd> <dt><a href="#event_memberships-updated">"memberships-updated"</a></dt> <dd>Webhook Memberships Updated event </dd> <dt><a href="#event_memberships-deleted">"memberships-deleted"</a></dt> <dd>Webhook Memberships Deleted event </dd> <dt><a href="#event_messages-created">"messages-created"</a></dt> <dd>Webhook Messages Created event </dd> <dt><a href="#event_messages-deleted">"messages-deleted"</a></dt> <dd>Webhook Messages Deleted event </dd> <dt><a href="#event_rooms-created">"rooms-created"</a></dt> <dd>Webhook Rooms Created event </dd> <dt><a href="#event_rooms-updated">"rooms-updated"</a></dt> <dd>Webhook Rooms Updated event </dd> <dt><a href="#event_request">"request"</a></dt> <dd>Webhook request event </dd> </dl>

Spark

Kind: global class
Properties

Name	Type	Description
options	<code>Object.<Options></code>	Sparky options object

Spark
- new Spark(options)
- instance
 - .setToken(token) ⇒ <code>Promise.String</code>
- static
 - .contentGet(contentId) ⇒ <code>Promise.<File></code>
 - .contentCreate(filePath, [timeout]) ⇒ <code>Promise.<File></code>
 - .eventsGet([eventSearch], [max]) ⇒ <code>Promise.Array.<Event></code>
 - .eventGet(eventId) ⇒ <code>Promise.<Event></code>
 - .licensesGet([orgId], [max]) ⇒ <code>Promise.Array.<License></code>
 - .licenseGet(licenseId) ⇒ <code>Promise.<License></code>
 - .membershipsGet([membershipSearch], [max]) ⇒ <code>Promise.Array.<Membership></code>
 - .membershipGet(membershipId) ⇒ <code>Promise.<Membership></code>
 - .membershipAdd(roomId, personEmail, [isModerator]) ⇒ <code>Promise.<Membership></code>
 - .membershipUpdate(membership) ⇒ <code>Promise.<Membership></code>
 - .membershipRemove(membershipId) ⇒ <code>Promise</code>
 - .messagesGet(messageSearch, [max]) ⇒ <code>Promise.Array.<Message></code>
 - .messageGet(messageId) ⇒ <code>Promise.<Message></code>
 - .messageSend(message, [file]) ⇒ <code>Promise.<Message></code>
 - .messageRemove(messageId) ⇒ <code>Promise</code>
 - .organizationsGet([max]) ⇒ <code>Promise.Array.<Organization></code>
 - .organizationGet(orgId) ⇒ <code>Promise.<Organization></code>
 - .peopleGet([personSearch], [max]) ⇒ <code>Promise.Array.<Person></code>
 - .personGet(personId) ⇒ <code>Promise.<Person></code>
 - .personMe() ⇒ <code>Promise.<Person></code>
 - .personAdd(person) ⇒ <code>Promise.<Person></code>
 - .personUpdate(person) ⇒ <code>Promise.<Person></code>
 - .personRemove(personId) ⇒ <code>Promise</code>
 - .rolesGet([max]) ⇒ <code>Promise.Array.<Role></code>
 - .roleGet(roleId) ⇒ <code>Promise.<Role></code>
 - .roomsGet([roomSearch], [max]) ⇒ <code>Promise.Array.<Room></code>
 - .roomGet(roomId) ⇒ <code>Promise.<Room></code>
 - .roomAdd(title, [teamId]) ⇒ <code>Promise.<Room></code>
 - .roomUpdate(room) ⇒ <code>Promise.<Room></code>
 - .roomRemove(roomId) ⇒ <code>Promise</code>
 - .teamsGet([max]) ⇒ <code>Promise.Array.<Team></code>
 - .teamGet(teamId) ⇒ <code>Promise.<Team></code>
 - .teamAdd(name) ⇒ <code>Promise.<Team></code>
 - .teamUpdate(team) ⇒ <code>Promise.<Team></code>
 - .teamRemove(teamId) ⇒ <code>Promise</code>
 - .teamMembershipsGet(teamId, [max]) ⇒ <code>Promise.Array.<TeamMembership></code>
 - .teamMembershipGet(membershipId) ⇒ <code>Promise.<TeamMembership></code>
 - .teamMembershipAdd(teamId, personEmail, isModerator) ⇒ <code>Promise.<TeamMembership></code>
 - .teamMembershipUpdate(teamMembership) ⇒ <code>Promise.<TeamMembership></code>
 - .teamMembershipRemove(membershipId) ⇒ <code>Promise</code>
 - .webhooksGet([webhookSearch], [max]) ⇒ <code>Promise.Array.<Webhook></code>
 - .webhookGet(webhookId) ⇒ <code>Promise.<Webhook></code>
 - .webhookAdd(webhookObj) ⇒ <code>Promise.<Webhook></code>
 - .webhookUpdate(webhookObj) ⇒ <code>Promise.<Webhook></code>
 - .webhookRemove(webhookId) ⇒ <code>Promise</code>
 - .webhookAuth(secret, signature, payload) ⇒ <code>Promise.String</code> | <code>Object</code>
 - .webhookListen() ⇒ <code>webhookHandler</code>
 - ~webhookHandler(req, [res], [next]) ⇒ <code>Null</code>

new Spark(options)

Creates a Spark API instance that is then attached to a Spark Account.

Param	Type	Description
options	<code>Object.<Options></code>	Sparky options object

Example

const Spark = require('node-sparky');

const spark = new Spark({
  token: '<my token>',
  webhookSecret: 'somesecr3t',
});

spark.roomsGet(10)
  .then(rooms => rooms.forEach(room => console.log(room.title)))
  .catch(err => console.log(err);

spark.setToken(token) ⇒ <code>Promise.String</code>

Set/Reset API token used in a Sparky instance. Use this function when needing to change an expired Token. Returns a fullfiled promise if token is valid, else returns a rejected promise.

Kind: instance method of <code>Spark</code>
Returns: <code>Promise.String</code> - Token promise

Param	Type	Description
token	<code>String</code>	Spark API token

Example

spark.setToken('Tm90aGluZyB0byBzZWUgaGVyZS4uLiBNb3ZlIGFsb25nLi4u')
  .then(token => console.log(token))
  .catch(err => console.error(err));

Spark.contentGet(contentId) ⇒ <code>Promise.<File></code>

Returns a File Object specified by Content ID or Content URL.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<File></code> - File object

Param	Type	Description
contentId	<code>String</code>	Spark Content ID or URL

Example

spark.contentGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then(file => console.log('File name: %s', file.name))
  .catch(err => console.error(err));

Spark.contentCreate(filePath, [timeout]) ⇒ <code>Promise.<File></code>

Create File Object from local file path.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<File></code> - File

Param	Type	Default	Description
filePath	<code>String</code>		Path to file
[timeout]	<code>Integer</code>	<code>15000</code>	Timeout in ms to read file (optional)

Example

spark.contentCreate('/some/local/file.png')
  .then(file => console.log(file.name))
  .catch(err => console.error(err));

Spark.eventsGet([eventSearch], [max]) ⇒ <code>Promise.Array.<Event></code>

List events in your organization. Several query parameters are available to filter the response. Long result sets will be split into pages. Requires admin permissions in organization.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.Array.<Event></code> - Events Collection

Param	Type	Description
[eventSearch]	<code>Object</code>	Spark Event Search Object
[max]	<code>Integer</code>	Number of records to return (optional)

Example

spark.eventsGet({ resource: 'messages' }, 10)
  .then(events => events.forEach(event => console.log(event.data.text)))
  .catch(err => console.error(err));

Spark.eventGet(eventId) ⇒ <code>Promise.<Event></code>

Return details of Spark Event by ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Event></code> - Spark Event object

Param	Type	Description
eventId	<code>String</code>	Spark Event ID

Example

spark.eventGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then(event => console.log(event.data.text))
  .catch(err => console.error(err));

Spark.licensesGet([orgId], [max]) ⇒ <code>Promise.Array.<License></code>

Returns all Spark Licenses for a given Organization ID. If no organization ID argument is passed, licenses are returned for the Organization that the authenticated account is in. If 'max' is not specifed, returns all. Alternativly, you can pass a licenses object instead of the orgId string.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.Array.<License></code> - Licenses Collection

Param	Type	Description
[orgId]	<code>String</code>	The organization ID to query (optional)
[max]	<code>Integer</code>	Number of records to return (optional)

Example

spark.licensesGet('Tm90aGluZyB0byBzZWUgaGVy', 10)
  .then(licenses => licenses.forEach(license => console.log(license.name)))
  .catch(err => console.error(err));

Example

const licenseSearchObj = {
  orgId: 'Tm90aGluZyB0byBzZWUgaGVy',
};
spark.licensesGet(licenseSearchObj, 10)
  .then(licenses => licenses.forEach(license => console.log(license.name)))
  .catch(err => console.error(err));

Spark.licenseGet(licenseId) ⇒ <code>Promise.<License></code>

Returns a Spark License specified by License ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<License></code> - License

Param	Type	Description
licenseId	<code>String</code>	Spark License ID

Example

spark.licenseGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then(license => console.log(license.name))
  .catch(err => console.error(err));

Spark.membershipsGet([membershipSearch], [max]) ⇒ <code>Promise.Array.<Membership></code>

Returns all Spark Memberships that the authenticated account is in. If 'max' is not specifed, returns all.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.Array.<Membership></code> - Array of Spark Membership objects

Param	Type	Description
[membershipSearch]	<code>Object</code>	Spark Membership Search Object (optional)
[max]	<code>Integer</code>	Number of records to return

Example

spark.membershipsGet({ roomId: 'Tm90aGluZyB0byBzZWUgaGVy' }, 10)
  .then(memberships => memberships.forEach(membership => console.log(membership.id)))
  .catch(err => console.error(err));

Spark.membershipGet(membershipId) ⇒ <code>Promise.<Membership></code>

Returns Spark Membership by ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Membership></code> - Spark Membership object

Param	Type	Description
membershipId	<code>String</code>	Spark Membership ID

Example

spark.membershipGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then(membership => console.log(membership.id))
  .catch(err => console.error(err));

Spark.membershipAdd(roomId, personEmail, [isModerator]) ⇒ <code>Promise.<Membership></code>

Add new Spark Membership given Room ID, email address, and moderator status. Alternativly, you can pass a membership object as the only argument.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Membership></code> - Spark Membership object

Param	Type	Description
roomId	<code>String</code>	Spark Room ID
personEmail	<code>String</code>	Email address of person to add
[isModerator]	<code>Boolean</code>	True if moderator

Example

spark.membershipAdd('Tm90aGluZyB0byBzZWUgaGVy', 'aperson@company.com')
  .then(membership => console.log(membership.id))
  .catch(err => console.error(err));

Example

const membershipObj = {
  personEmail: 'test@test.com',
  roomId: 'Tm90aGluZyB0byBzZWUgaGVy',
  isModerator: true,
};
spark.membershipAdd(membershipObj)
  .then(membership => console.log(membership.id))
  .catch(err => console.error(err));

Spark.membershipUpdate(membership) ⇒ <code>Promise.<Membership></code>

Update a Membership.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Membership></code> - Spark Membership object

Param	Type	Description
membership	<code>Object.<Membership></code>	Spark Membership object

Example

spark.membershipGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then((membership) => {
    membership.isModerator = true;
    return spark.membershipUpdate(membership);
  )
  .then(membership => console.log(membership.isModerator))
  .catch(err => console.error(err));

Spark.membershipRemove(membershipId) ⇒ <code>Promise</code>

Remove Spark Membership by ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise</code> - Fulfilled promise

Param	Type	Description
membershipId	<code>String</code>	Spark Membership ID

Example

spark.membershipRemove('Tm90aGluZyB0byBzZWUgaGVy')
  .then(() => console.log('Membership removed.'))
  .catch(err => console.error(err));

Spark.messagesGet(messageSearch, [max]) ⇒ <code>Promise.Array.<Message></code>

Returns Spark Message Objects. If 'max' is not specifed, returns all.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.Array.<Message></code> - Array of Spark Message objects

Param	Type	Description
messageSearch	<code>Object</code>	Spark Message Search Object
[max]	<code>Integer</code>	Number of records to return (optional)

Example

spark.messagesGet({roomId: 'Tm90aGluZyB0byBzZWUgaGVy'}, 100)
  .then(messages => messages.forEach(message => console.log(message.text)))
  .catch(err => console.error(err));

Spark.messageGet(messageId) ⇒ <code>Promise.<Message></code>

Return details of Spark Message by ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Message></code> - Spark Message object

Param	Type	Description
messageId	<code>String</code>	Spark Message ID

Example

spark.messageGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then(message => console.log(message.text))
  .catch(err => console.error(err));

Spark.messageSend(message, [file]) ⇒ <code>Promise.<Message></code>

Send Spark Message.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Message></code> - Spark Message object

Param	Type	Description
message	<code>Object.<MessageAdd></code>	Spark Message Add Object
[file]	<code>Object.<File></code>	File Object to add to message (optional)

Example

const newMessage = {
  roomId: 'Tm90aGluZyB0byBzZWUgaGVy',
  text: 'Hello World'
};

spark.contentCreate('/some/file/with.ext')
  .then(file => spark.messageSend(newMessage, file))
  .then(message => console.log(message.id))
  .catch(err => console.error(err));

Spark.messageRemove(messageId) ⇒ <code>Promise</code>

Remove Spark Message by ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise</code> - Fulfilled promise

Param	Type	Description
messageId	<code>String</code>	Spark Message ID

Example

spark.messageRemove('Tm90aGluZyB0byBzZWUgaGVy')
  .then(() => console.log('Message removed.'))
  .catch(err => console.error(err));

Spark.organizationsGet([max]) ⇒ <code>Promise.Array.<Organization></code>

Return all Spark Organizations that the authenticated account is in. If 'max' is not specifed, returns all.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.Array.<Organization></code> - Array of Spark Organization objects

Param	Type	Description
[max]	<code>Integer</code>	Number of records to return (optional)

Example

spark.organizationsGet(10)
  .then(organizations => organizations.forEach(organization => console.log(organization.id)))
  .catch(err => console.error(err));

Spark.organizationGet(orgId) ⇒ <code>Promise.<Organization></code>

Return Spark Organization specified by License ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Organization></code> - Spark Organization object

Param	Type	Description
orgId	<code>String</code>	Spark Organization ID

Example

spark.organizationGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then(organization => console.log(organization.id))
  .catch(err => console.error(err));

Spark.peopleGet([personSearch], [max]) ⇒ <code>Promise.Array.<Person></code>

Returns Spark Person Objects. If no arguments are passed and if the authenticated account is part of an Organization and if authenticated account is assigned the Role of Organization Admin, returns all Spark Person objects from the Organizations that the user is in. Otherwise, the PersonSearch object should contain the key "id", "displayName", or "email" to query. If 'max' is not specifed, returns all matched Person Objects.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.Array.<Person></code> - Array of Spark Person objects

Param	Type	Description
[personSearch]	<code>Object</code>	Spark Person Search Object (optional)
[max]	<code>Integer</code>	Number of records to return (optional)

Example

spark.peopleGet({ displayName: 'John' }, 10)
  .then(people => people.forEach(person => console.log(person.displayName)))
  .catch(err => console.error(err));

Spark.personGet(personId) ⇒ <code>Promise.<Person></code>

Returns a Spark Person Object specified by Person ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Person></code> - Spark Person object

Param	Type	Description
personId	<code>String</code>	Spark Person ID

Example

spark.personGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then(person => console.log(person.displayName))
  .catch(err => console.error(err));

Spark.personMe() ⇒ <code>Promise.<Person></code>

Return the Spark Person Object of the authenticated account.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Person></code> - Spark Person object
Example

spark.personMe()
  .then(person => console.log(person.displayName))
  .catch(err => console.error(err));

Spark.personAdd(person) ⇒ <code>Promise.<Person></code>

Add new Person.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Person></code> - Spark Person object

Param	Type	Description
person	<code>Object.<Person></code>	Spark Person object

Example

let newPerson = {
  emails: ['aperson@company.com'],
  displayName: 'Any Person',
  firstName: 'Any',
  lastName: 'Person',
  avatar: 'http://lorempixel.com/400/400/',
  orgId: 'Tm90aGluZyB0byBzZWUgaGVy',
  roles: ['Tm90aGluZyB0byBzZWUgaGVy'],
  licenses: ['Tm90aGluZyB0byBzZWUgaGVy']
};

spark.personAdd(newPerson)
  .then(person => console.log(person.displayName))
  .catch(err => console.error(err));

Spark.personUpdate(person) ⇒ <code>Promise.<Person></code>

Update a Person.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Person></code> - Spark Person object

Param	Type	Description
person	<code>Object.<Person></code>	Spark Person object

Example

spark.personGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then((person) => {
    person.displayName = 'Another Person';
    return spark.personUpdate(person);
  })
  .then(person => console.log(person.displayName))
  .catch(err => console.error(err));

Spark.personRemove(personId) ⇒ <code>Promise</code>

Remove Spark Person by ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise</code> - Fulfilled promise

Param	Type	Description
personId	<code>String</code>	Spark Person ID

Example

spark.personRemove('Tm90aGluZyB0byBzZWUgaGVy')
  .then(() => console.log('Person removed.'))
  .catch(err => console.error(err));

Spark.rolesGet([max]) ⇒ <code>Promise.Array.<Role></code>

Returns all Spark Roles that the authenticated account is in. If 'max' is not specifed, returns all.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.Array.<Role></code> - Array of Spark Role object

Param	Type	Description
[max]	<code>Integer</code>	Number of records to return (optional)

Example

spark.rolesGet(10)
  .then(roles => roles.forEach(role => console.log(role.name)))
  .catch(err => console.error(err));

Spark.roleGet(roleId) ⇒ <code>Promise.<Role></code>

Returns details for a Spark Role pecified by Role ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Role></code> - Spark Role object

Param	Type	Description
roleId	<code>String</code>	Spark Role ID

Example

spark.roleGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then(role => console.log(role.name))
  .catch(err => console.error(err));

Spark.roomsGet([roomSearch], [max]) ⇒ <code>Promise.Array.<Room></code>

Returns Spark Room Objects. If roomSearch argument is not passed, returns all Spark Rooms that the authenticated account is in. If 'max' is not specifed, returns all.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.Array.<Room></code> - Array of Spark Room objects

Param	Type	Description
[roomSearch]	<code>Object.<RoomSearch></code>	Spark Person Search Object (optional)
[max]	<code>Integer</code>	Number of records to return (optional)

Example

spark.roomsGet({ type: 'group' }, 10)
  .then(rooms => rooms.forEach(room => console.log(room.title)))
  .catch(err => console.error(err));

Spark.roomGet(roomId) ⇒ <code>Promise.<Room></code>

Returns a Spark Room Object specified by Room ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Room></code> - Spark Room object

Param	Type	Description
roomId	<code>String</code>	Spark Room ID

Example

spark.roomGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then(room => console.log(room.title))
  .catch(err => console.error(err));

Spark.roomAdd(title, [teamId]) ⇒ <code>Promise.<Room></code>

Add new Spark Room.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Room></code> - Spark Room object

Param	Type	Description
title	<code>String</code>	Title for a new Room
[teamId]	<code>String</code>	Team ID (optional)

Example

spark.roomAdd('myroom')
  .then(room => console.log(room.title))
  .catch(err => console.error(err));

Spark.roomUpdate(room) ⇒ <code>Promise.<Room></code>

Update a Spark Room.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Room></code> - Spark Room object

Param	Type	Description
room	<code>Object.<Room></code>	Spark Room object

Example

spark.roomGet(Tm90aGluZyB0byBzZWUgaGVy)
  .then((room) => {
    room.title = 'Another Title';
    return spark.roomUpdate(room);
  )
  .then(room => console.log(room.title))
  .catch(err => console.error(err));

Spark.roomRemove(roomId) ⇒ <code>Promise</code>

Remove Spark Room by ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise</code> - Fulfilled promise

Param	Type	Description
roomId	<code>String</code>	Spark Room ID

Example

spark.roomRemove('Tm90aGluZyB0byBzZWUgaGVy')
  .then(() => console.log('Room removed.'))
  .catch(err => console.error(err));

Spark.teamsGet([max]) ⇒ <code>Promise.Array.<Team></code>

Return all Spark Teams that the authenticated account is in. If 'max' is not specifed, returns all.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.Array.<Team></code> - Teams Collection

Param	Type	Description
[max]	<code>Integer</code>	Number of records to return (optional)

Example

spark.teamsGet(10)
  .then(teams => teams.forEach(team => console.log(team.name)))
  .catch(err => console.error(err));

Spark.teamGet(teamId) ⇒ <code>Promise.<Team></code>

Returns a Spark Team Object specified by Team ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Team></code> - Team

Param	Type	Description
teamId	<code>String</code>	Spark Team ID

Example

spark.teamGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then(team => console.log(team.name))
  .catch(err => console.error(err));

Spark.teamAdd(name) ⇒ <code>Promise.<Team></code>

Add new Spark Team.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Team></code> - Team

Param	Type	Description
name	<code>String</code>	Name for new Team

Example

spark.teamAdd('myteam')
  .then(team => console.log(team.name))
  .catch(err => console.error(err));

Spark.teamUpdate(team) ⇒ <code>Promise.<Team></code>

Update a Team.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Team></code> - Team

Param	Type	Description
team	<code>Object.<Team></code>	Spark Team Object

Example

spark.teamGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then((team) => {
    team.name = 'Another Team';
    return spark.teamUpdate(team);
  })
  .then(team => console.log(team.name))
  .catch(err => console.error(err));

Spark.teamRemove(teamId) ⇒ <code>Promise</code>

Remove Spark Team by ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise</code> - Fulfilled promise

Param	Type	Description
teamId	<code>String</code>	Spark Team ID

Example

spark.teamRemove('Tm90aGluZyB0byBzZWUgaGVy')
  .then(() => console.log('Team removed.'))
  .catch(err => console.error(err));

Spark.teamMembershipsGet(teamId, [max]) ⇒ <code>Promise.Array.<TeamMembership></code>

Return all Spark Team Memberships for a specific Team that the authenticated account is in. If 'max' is not specifed, returns all.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.Array.<TeamMembership></code> - Array of Spark TeamMembership objects

Param	Type	Description
teamId	<code>String</code>	Spark Team Memebership ID
[max]	<code>Integer</code>	Number of records to return

Example

spark.teamMembershipsGet('Tm90aGluZyB0byBzZWUgaGVy', 100)
  .then(tms => tms.forEach(tm => console.log(tm.personEmail)))
  .catch(err => console.error(err));

Spark.teamMembershipGet(membershipId) ⇒ <code>Promise.<TeamMembership></code>

Return Spark Team Membership specified by Membership ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<TeamMembership></code> - Spark TeamMembership object

Param	Type	Description
membershipId	<code>String</code>	Spark Membership ID

Example

spark.membershipGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then(tm => console.log(tm.personEmail))
  .catch(err => console.error(err));

Spark.teamMembershipAdd(teamId, personEmail, isModerator) ⇒ <code>Promise.<TeamMembership></code>

Add new Spark Team Membership.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<TeamMembership></code> - Spark TeamMembership object

Param	Type	Description
teamId	<code>String</code>	Spark Team Memebership ID
personEmail	<code>String</code>	Email address of person to add
isModerator	<code>Boolean</code>	Boolean value to add as moderator

Example

spark.teamMembershipAdd('Tm90aGluZyB0byBzZWUgaGVy', 'aperson@company.com')
  .then(tm => console.log(tm.personEmail))
  .catch(err => console.error(err));

Example

const teamMembershipObj = {
  personEmail: 'test@test.com',
  teamId: 'Tm90aGluZyB0byBzZWUgaGVy',
  isModerator: true,
};
spark.teamMembershipAdd(teamMembershipObj)
  .then(tm => console.log(tm.personEmail))
  .catch(err => console.error(err));

Spark.teamMembershipUpdate(teamMembership) ⇒ <code>Promise.<TeamMembership></code>

Update a Team Membership.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<TeamMembership></code> - Spark TeamMembership object

Param	Type	Description
teamMembership	<code>object.<TeamMembership></code>	Spark TeamMembership object

Example

spark.teamMembershipGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then((tm) => {
    tm.isModerator = true;
    return spark.teamMembershipUpdate(tm);
  )
  .then(tm => console.log(tm.isModerator))
  .catch(err => console.error(err));

Spark.teamMembershipRemove(membershipId) ⇒ <code>Promise</code>

Remove Spark Team Membership by ID..

Kind: static method of <code>Spark</code>
Returns: <code>Promise</code> - Fulfilled promise

Param	Type	Description
membershipId	<code>String</code>	Spark Team Membership ID

Example

spark.teamMembershipRemove('Tm90aGluZyB0byBzZWUgaGVy')
  .then(() => console.log('Team Membership removed.'))
  .catch(err => console.error(err));

Spark.webhooksGet([webhookSearch], [max]) ⇒ <code>Promise.Array.<Webhook></code>

Returns all webhooks for authenticated account with optional search criteria to filter results. If 'max' is not specifed, returns all.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.Array.<Webhook></code> - Array of Spark Webhook objects

Param	Type	Description
[webhookSearch]	<code>Object</code>	Webhook Search object
[max]	<code>Integer</code>	Number of records to return

Example

spark.webhooksGet(10)
  .then(webhooks => webhooks.forEach(webhook => console.log(webhook.name)))
  .catch(err => console.error(err));

Example

spark.webhooksGet({ name: 'My Awesome Webhook' }, 10)
  .then(webhooks => webhooks.forEach(webhook => console.log(webhook.name)))
  .catch(err => console.error(err));

Spark.webhookGet(webhookId) ⇒ <code>Promise.<Webhook></code>

Returns details of Spark Webhook Object specified by Webhook ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Webhook></code> - Spark Webhook object

Param	Type	Description
webhookId	<code>String</code>	Spark Webhook ID

Example

spark.webhookGet('Tm90aGluZyB0byBzZWUgaGVy')
  .then(webhook => console.log(webhook.name))
  .catch(err => console.error(err));

Spark.webhookAdd(webhookObj) ⇒ <code>Promise.<Webhook></code>

Add new Webhook.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Webhook></code> - Spark Webhook object

Param	Type	Description
webhookObj	<code>Object.<Webhook></code>	Spark Webhook object

Example

const newWebhook = {
  name: 'my webhook',
  targetUrl: 'https://example.com/webhook',
  resource: 'memberships',
  event: 'created',
  filter: 'roomId=Tm90aGluZyB0byBzZWUgaGVy'
};

spark.webhookAdd(newWebhook)
  .then(webhook => console.log(webhook.name))
  .catch(err => console.error(err));

Spark.webhookUpdate(webhookObj) ⇒ <code>Promise.<Webhook></code>

Update a Webhook.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.<Webhook></code> - Spark Webhook Object

Param	Type	Description
webhookObj	<code>Object.<Webhook></code>	Spark Webhook Object

Example

spark.webhookGet(Tm90aGluZyB0byBzZWUgaGVy)
  .then((webhook) => {
    webhook.name = 'Another Webhook';
    return spark.webhookUpdate(webhook);
  })
  .then(webhook => console.log(webhook.name))
  .catch(err => console.error(err));

Spark.webhookRemove(webhookId) ⇒ <code>Promise</code>

Remove Spark Webhook by ID.

Kind: static method of <code>Spark</code>
Returns: <code>Promise</code> - Fulfilled promise

Param	Type	Description
webhookId	<code>String</code>	Spark Webhook ID.

Example

spark.webhookRemove('Tm90aGluZyB0byBzZWUgaGVy')
  .then(() => console.log('Webhook removed.'))
  .catch(err => console.error(err));

Spark.webhookAuth(secret, signature, payload) ⇒ <code>Promise.String</code> | <code>Object</code>

Authenticate X-Spark-Signature HMAC-SHA1 Hash.

Kind: static method of <code>Spark</code>
Returns: <code>Promise.String</code> | <code>Object</code> - payload

Param	Type	Description
secret	<code>String</code>	Value of secret used when creating webhook
signature	<code>String</code>	Value of "X-Spark-Signature" from header
payload	<code>String</code> \| <code>Object</code>	This can either be the json object or a string representation of the webhook's body json payload

Example

const sig = req.headers['x-spark-signature'];
const secret = 'mySecret';

spark.webhookAuth(secret, sig, req.body)
  .then(() => console.log('Webhook is valid');
  .catch(err => console.error(err));

Spark.webhookListen() ⇒ <code>webhookHandler</code>

Process request from connect, express, or resitify routes. Returns function that accepts req, res, and next arguments.

Kind: static method of <code>Spark</code>
Returns: <code>webhookHandler</code> - function
Example

const Spark = require('node-sparky');
const express = require('express');
const bodyParser = require('body-parser');
const when = require('when');

const spark = new Spark({
  token: '<my token>',
  webhookSecret: 'somesecr3t',
});

const port = parseInt(process.env.PORT || '3000', 10);

// add events
spark.on('messages-created', msg => console.log(`${msg.personEmail} said: ${msg.text}`));

const app = express();
app.use(bodyParser.json());

// add route for path that is listening for web hooks
app.post('/webhook', spark.webhookListen());

// start express server
app.listen(port, function() {
  // get exisiting webhooks
  spark.webhooksGet()
    // remove all existing webhooks
    .then(webhooks => when.map(webhooks, webhook => spark.webhookRemove(webhook.id)))
    // create spark webhook directed back to the externally accessible
    // express route defined above.
    .then(() => spark.webhookAdd({
      name: 'my webhook',
      targetUrl: 'https://example.com/webhook',
      resource: 'all',
      event: 'all',
    });
  console.log(`Listening on port ${port}`);
});

webhookListen~webhookHandler(req, [res], [next]) ⇒ <code>Null</code>

Function returned by spark.webhookListen()

Kind: inner method of <code>webhookListen</code>
Returns: <code>Null</code> - null value

Param	Type	Description
req	<code>Object</code>	request object
[res]	<code>Object</code>	response object
[next]	<code>function</code>	next function

File : <code>object</code>

File Object

Kind: global namespace
Properties

Name	Type	Description
name	<code>String</code>	File name
ext	<code>String</code>	File extension
type	<code>String</code>	Header [content-type] for file
binary	<code>Buffer</code>	File contents as binary
base64	<code>String</code>	File contents as base64 encoded string

Event : <code>object</code>

Event Object

Kind: global namespace
Properties

Name	Type	Description
id	<code>String</code>	Event ID
resource	<code>String</code>	Event resource
type	<code>String</code>	Event type
actorId	<code>String</code>	Person ID that triggered event
orgId	<code>String</code>	Organzation ID that event occurred in
appId	<code>String</code>	Application ID
created	<code>String</code>	Date Event created (ISO 8601)
data	<code>Object</code>	Event data object

License : <code>object</code>

License Object

Kind: global namespace
Properties

Name	Type	Description
id	<code>String</code>	License ID
name	<code>String</code>	License name
totalUnits	<code>Integer</code>	Total units of license available
consumedUnits	<code>Integer</code>	Number of license units consumed

Membership : <code>object</code>

Membership Object

Kind: global namespace
Properties

Name	Type	Description
id	<code>String</code>	Membership ID
roomId	<code>String</code>	Room ID
personId	<code>String</code>	Person ID
personEmail	<code>String</code>	Person Email
isModerator	<code>Boolean</code>	Membership is a moderator
isMonitor	<code>Boolean</code>	Membership is a monitor
created	<code>String</code>	Date Membership created (ISO 8601)

Message : <code>object</code>

Message Object

Kind: global namespace
Properties

Name	Type	Description
id	<code>String</code>	Message ID
roomId	<code>String</code>	Room ID
roomType	<code>String</code>	Room Type
toPersonId	<code>String</code>	Person ID
toPersonEmail	<code>String</code>	Person Email
text	<code>String</code>	Message text
markdown	<code>String</code>	Message markdown
files	<code>Array.<String></code>	Array of File URLs
personId	<code>String</code>	Person ID
personEmail	<code>String</code>	Person Email
created	<code>String</code>	Date Message created (ISO 8601)
mentionedPeople	<code>Array.String</code>	Person IDs of those mentioned in Message

Organization : <code>object</code>

Organization Object

Kind: global namespace
Properties

Name	Type	Description
id	<code>String</code>	Organization ID
displayName	<code>String</code>	Organization name
created	<code>String</code>	Date Organization created (ISO 8601)

Person : <code>object</code>

Person Object

Kind: global namespace
Properties

Name	Type	Description
id	<code>String</code>	Person ID
emails	<code>Array.String</code>	Array of email addresses
displayName	<code>String</code>	Display name
firstName	<code>String</code>	First name
lastName	<code>String</code>	Last name
avatar	<code>String</code>	Avatar URL
orgId	<code>String</code>	Organization ID
roles	<code>Array.String</code>	Array of assigned Role IDs
licenses	<code>Array.String</code>	Array of assigned License IDs
created	<code>String</code>	Date created (ISO 8601)

Role : <code>object</code>

Role Object

Kind: global namespace
Properties

Name	Type	Description
id	<code>String</code>	Role ID
name	<code>String</code>	Role name

Room : <code>object</code>

Room Object

Kind: global namespace
Properties

Name	Type	Description
id	<code>String</code>	Room ID
title	<code>String</code>	Room Title
type	<code>String</code>	Room Type
isLocked	<code>Boolean</code>	Room Moderated/Locked
teamId	<code>String</code>	Team ID
lastActivity	<code>String</code>	Last Activity in Room (ISO 8601)
creatorId	<code>String</code>	person ID of Room creator (ISO 8601)
created	<code>String</code>	Room Created (ISO 8601)

Team : <code>object</code>

Team Object

Kind: global namespace
Properties

Name	Type	Description
id	<code>String</code>	Message ID
name	<code>String</code>	Team name
created	<code>String</code>	Date Team created (ISO 8601)

TeamMembership : <code>object</code>

Team Membership Object

Kind: global namespace
Properties

Name	Type	Description
id	<code>String</code>	Membership ID
teamId	<code>String</code>	Team ID
personId	<code>String</code>	Person ID
personEmail	<code>String</code>	Person Email
isModerator	<code>Boolean</code>	Membership is a moderator
created	<code>String</code>	Date Membership created (ISO 8601)

Webhook : <code>object</code>

Webhook Object

Kind: global namespace
Properties

Name	Type	Description
id	<code>String</code>	Webhook ID
name	<code>String</code>	Webhook name
targetUrl	<code>String</code>	Webhook target URL
resource	<code>String</code>	Webhook resource
event	<code>String</code>	Webhook event
filter	<code>String</code>	Webhook filter
created	<code>String</code>	Date Webhook created (ISO 8601)

Validator : <code>object</code>

Spark Object Validation

Kind: global namespace

Validator : <code>object</code>
- .isFile(filePath) ⇒ <code>Promise.String</code>
- .isDir(dirPath) ⇒ <code>Promise.String</code>
- .isToken(token) ⇒ <code>Promise.String</code>
- .isEmail(email) ⇒ <code>Boolean</code>
- .isEmails(emails) ⇒ <code>Boolean</code>
- .isUrl(url) ⇒ <code>Boolean</code>
- .isFilePath(path) ⇒ <code>Boolean</code>
- .isOptions(options) ⇒ <code>Boolean</code>
- .isFile(file) ⇒ <code>Boolean</code>
- .isEvent(event) ⇒ <code>Boolean</code>
- .isEvents(events) ⇒ <code>Boolean</code>
- .isEventSearch(searchObj) ⇒ <code>Boolean</code>
- .isLicense(license) ⇒ <code>Boolean</code>
- .isLicenses(licenses) ⇒ <code>Boolean</code>
- .isLicenseSearch(searchObj) ⇒ <code>Boolean</code>
- .isMembership(membership) ⇒ <code>Boolean</code>
- .isMemberships(memberships) ⇒ <code>Boolean</code>
- .isMembershipSearch(searchObj) ⇒ <code>Boolean</code>
- .isMessage(message) ⇒ <code>Boolean</code>
- .isMessages(messages) ⇒ <code>Boolean</code>
- .isMessageSearch(searchObj) ⇒ <code>Boolean</code>
- .isOrganization(organization) ⇒ <code>Boolean</code>
- .isOrganizations(organizations) ⇒ <code>Boolean</code>
- .isPerson(person) ⇒ <code>Boolean</code>
- .isPeople(people) ⇒ <code>Boolean</code>
- .isPersonSearch(searchObj) ⇒ <code>Boolean</code>
- .isRole(role) ⇒ <code>Boolean</code>
- .isRoles(roles) ⇒ <code>Boolean</code>
- .isRoom(room) ⇒ <code>Boolean</code>
- .isRooms(rooms) ⇒ <code>Boolean</code>
- .isRoomSearch(searchObj) ⇒ <code>Boolean</code>
- .isTeam(team) ⇒ <code>Boolean</code>
- .isTeams(teams) ⇒ <code>Boolean</code>
- .isTeamMembership(teamMembership) ⇒ <code>Boolean</code>
- .isTeamMemberships(teamMemberships) ⇒ <code>Boolean</code>
- .isTeamMembershipSearch(searchObj) ⇒ <code>Boolean</code>
- .isWebhook(webhook) ⇒ <code>Boolean</code>
- .isWebhooks(webhooks) ⇒ <code>Boolean</code>
- .isWebhookSearch(searchObj) ⇒ <code>Boolean</code>

Validator.isFile(filePath) ⇒ <code>Promise.String</code>

Validate filePath resolves to existing file. Returns fulfilled Promise with filePath if valid, else returns rejected Promise if not valid.

Kind: static method of <code>Validator</code>
Returns: <code>Promise.String</code> - Absolute path to file

Param	Type	Description
filePath	<code>String</code>	Absolute path to file

Validator.isDir(dirPath) ⇒ <code>Promise.String</code>

Validate filePath resolves to existing dir. Returns fulfilled Promise with dirPath if valid, else returns rejected Promise if not valid.

Kind: static method of <code>Validator</code>
Returns: <code>Promise.String</code> - Absolute path to a directory

Param	Type	Description
dirPath	<code>String</code>	Absolute path to a directory

Validator.isToken(token) ⇒ <code>Promise.String</code>

Validate Spark Token is valid by sending request to API to determine if authorized. Returns fulfilled Promise with token if valid, else returns rejected Promise if not valid.

Kind: static method of <code>Validator</code>
Returns: <code>Promise.String</code> - Cisco Spark Token

Param	Type	Description
token	<code>String</code>	Cisco Spark Token