Javascript API for Smooch
JavaScript
Latest commit 12593a7 Jun 6, 2018

README.md

Smooch Core

Smooch Core is the most basic for interaction possible for the Smooch API. It wraps the public API in a convenient Javascript API.

This library is meant to be used server-side with Node.js.

Installation

$ npm install smooch-core --save

Contributing

If a method is missing please file an Issue, or better yet make a PR!

Usage

var SmoochCore = require('smooch-core');

// using generated JWT
var smooch = new SmoochCore({
    jwt: 'some-jwt'
});

// using JWT components
var smooch = new SmoochCore({
    keyId: 'some-key',
    secret: 'some-secret',
    scope: 'appUser', // account, app, or appUser
    userId: 'some-id' // only required for appUser scope
});

// ...

smooch.webhooks.get(id).then(function(response) {
  // do something with the response.
});

Usage with a proxy

If you need to use a proxy, you can use one of the many proxies available, as long as it an http.Agent implementation. You only need to pass the agent when creating the SmoochCore instance.

var SmoochCore = require('smooch-core');
var SocksProxyAgent = require('socks-proxy-agent');
var proxy = process.env.http_proxy || 'socks://localhost:8123';
var agent = new SocksProxyAgent(proxy);

var smooch = new SmoochCore({
    keyId: 'some-key',
    secret: 'some-secret',
    httpAgent: agent
});

API

Below is a list of methods included in Smooch Core. For comprehensive documentation of Smooch Core and its methods see Smooch's REST API docs.

For more detailed information and example usage of each of the following methods, click on the method's πŸ”— icon.

Method Description Link
appUsers Module
appUsers.get Get a specific appUser. πŸ”—
appUsers.update Update an appUser’s basic profile information and specify custom profile data. πŸ”—
appUsers.delete Delete an appUser. πŸ”—
appUsers.deleteProfile Delete an appUser’s profile. πŸ”—
appUsers.create Pre-create an appUser object before that appUser runs your app for the first time. πŸ”—
appUsers.linkChannel Link appUser to continue conversation on his/her preferred channel. πŸ”—
appUsers.unlinkChannel Remove the specified channel from the appUser’s clients. πŸ”—
appUsers.getMessages Get the specified appUser’s conversation history. πŸ”—
appUsers.resetUnreadCount Reset the unread count of the conversation to 0. πŸ”—
appUsers.typingActivity Notify Smooch when an app maker starts or stops typing a response. πŸ”—
appUsers.sendMessage Post a message to or from the appUser. πŸ”—
appUsers.deleteMessage Delete a single message. πŸ”—
appUsers.deleteMessages Clears the message history for an appUser, permanently deleting all messages. πŸ”—
appUsers.getChannels Get all of the appUser’s channel entity Ids. πŸ”—
appUsers.getBusinessSystems Get all the business systems to which an appUser’s conversation is connected. πŸ”—
appUsers.getAuthCode Get auth code. πŸ”—
appUsers.getLinkRequests Generate a transfer URL for a given channel type. πŸ”—
menu Module
menu.get Get the specified app’s menu. πŸ”—
menu.configure Configure the specified app’s menu. πŸ”—
menu.remove Remove the specified app’s menu. πŸ”—
webhooks Module
webhooks.list List all webhooks configured for a given app. πŸ”—
webhooks.create Create a webhook for the specified app. πŸ”—
webhooks.get Get individual webhooks. πŸ”—
webhooks.update Update existing webhooks. πŸ”—
webhooks.delete Delete specified webhook. πŸ”—
apps Module
apps.create Create a new app. πŸ”—
apps.list List all configured apps. πŸ”—
apps.get Get the specified app. πŸ”—
apps.delete Delete the specified app, including all its enabled integrations. πŸ”—
apps.keys.create Create a secret key for the specified app. πŸ”—
apps.keys.list List all secret keys for the sepcified app. πŸ”—
apps.keys.get Get a secret key. πŸ”—
apps.keys.delete Delete a secret key. πŸ”—
apps.keys.getJwt Get an app-scoped JWT signed using the requested keyId/secret pair. πŸ”—
integrations Module
integrations.create Create a new integration. πŸ”—
integrations.list List all integrations for a given app. πŸ”—
integrations.get Return the specified integration. πŸ”—
integrations.update Update the specified integration. πŸ”—
integrations.delete Delete the specified integration. πŸ”—
integrations.menu.get Get the specified integration’s menu. πŸ”—
integrations.menu.update Update the specified integration’s menu. πŸ”—
integrations.menu.delete Delete the specified integration's menu. πŸ”—
serviceAccounts Module
serviceAccounts.create Create a new service account. πŸ”—
serviceAccounts.list List all service accounts. πŸ”—
serviceAccounts.get Get the specified service account. πŸ”—
serviceAccounts.delete Delete the specified service account. πŸ”—
serviceAccounts.keys.create Create a secret key for the specified service account. πŸ”—
serviceAccounts.keys.list List all secret keys for the specified service account. πŸ”—
serviceAccounts.keys.get Get a specified secret key for the specified service account. πŸ”—
serviceAccounts.keys.delete Delete a specified secret key for the specified service account. πŸ”—
serviceAccounts.keys.getJwt Get an account-scoped JWT signed using the requested keyId/secret pair. πŸ”—
attachments Module
attachments.create Upload an attachment to Smooch to use in future messages. πŸ”—
attachments.delete Remove an attachment uploaded to Smooch πŸ”—

Release process

  1. Merge your changes in master.
  2. Wait for CircleCI to run the test suite on master.
  3. Run npm run release -- <level> --run. Replace <level> with patch, minor, major depending on which type of version this is.