kimono-client v0.0.3
NodeJS Client for Kimono
Thin wrapper around the v1 Kimono REST API. See the
API documentation for full details on the message formats and details on
obtaining an API key/setting up an end point.
Functions
Misc
setAPIKey
setAPIKey(apiKey)Set the API key to use with all function calls. This function must be called
first and allows use of all the sending functions. listen must be called
before receiving callbacks will be called.
listen
listen(port, callback)Have the Kimono client listen on the given port. If the port number is below
1024 the client will need to be started as sudo. You will need to setup the
server and port number as a web-hook end point with Kimono. You will also need a
valid API key.
Sending
read
read(conversationID, callback)Mark a conversation as read. The callback will receive two arguments, err and
result. See the API guide for full
details of the result object for this function.
create
create([recipientID], subject, message, callback)Create a new conversation with the given list of recipients. The conversation
will be given the subject of subject and be seeded with message. The
callback will receive two arguments, err and result. See the
API guide for full
details of the result object for this function.
list
list(callback)List all the conversations the client is a member of. The callback will receive
two arguments, err and result. See the
API Guide for full details
of the result object for this function.
reply
reply(conversationID, message, callback)Reply to an existing conversation with message. The callback will receive two
arguments, err and result. See the
API guide for full details of the
result object for this function.
view
view(conversationID, callback)Get a conversation object. The callback will receive two arguments, err and
result. See the API guide for full
details of the result object for this function.
Receiving
setMessageHandler
setMessageHandler(handler)Register a handler that will be called each time a new message is sent to the
client. The handler will receive two arguments, err and message. See the
message - new web-hook
documentation for details of the message format.
setBulkMessageHandler
setBulkMessageHandler(handler)Register a handler that will be called each time a new bulk message is sent to
the client. The handler will receive two arguments, err and message. See
the message - bulk-new
web-hook documentation for details of the bulk-message format.
setConversationHandler
setConversationHandler(handler)Register a handler that will be called each time a conversation is started with
the client. The handler will receive two arguments, err and message. See
the conversation - new
web-hook documentation for details of the bulk-message format.
Change Log
v0.0.3
- Fix Bot now responds to all requests with a
200
v0.0.2
- Fix Handlers now receive correct arguments
v0.0.1
- New Initial release
Todo
- Not all the endpoints are covered yet. This is partly due to some of them being buggy, and partly due to this being thrown together in a morning.
- Some tests might be useful
License
Copyright (c) 2015, Dom Davis dom.davis@rainbird.ai
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.