Skip to content

Commit

Permalink
Merge 22fcb97 into 85b768a
Browse files Browse the repository at this point in the history
  • Loading branch information
sstaley-sparkpost authored Oct 1, 2019
2 parents 85b768a + 22fcb97 commit 51836f4
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 1 deletion.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
## [Unreleased][unreleased]
- Security patches to dev-dependencies [#237](https://github.com/SparkPost/node-sparkpost/pull/237) by @jgzamora

## [2.1.4] - 2019-10-01
### Added
- Events API functionality by @sstaley-sparkpost
- Example for [searching the events/message API](/examples/events/search_message.js) by @sstaley-sparkpost.

## [2.1.3] - 2018-10-24
### Fixed
- Template preview draft option [bug](https://github.com/SparkPost/node-sparkpost/issues/233) by @jgzamora
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ Click on the desired API to see usage and more information

* [Inbound Domains](/docs/resources/inboundDomains.md) - `client.inboundDomains` ([examples](/examples/inboundDomains))
* [Message Events](/docs/resources/messageEvents.md) - `client.messageEvents` ([examples](/examples/messageEvents))
* [Events](/docs/resources/events.md) - `client.events` ([examples](/examples/events))
* [Recipient Lists](/docs/resources/recipientLists.md) - `client.recipientLists` ([examples](/examples/recipientLists))
* [Relay Webhooks](/docs/resources/relayWebhooks.md) - `client.relayWebhooks` ([examples](/examples/relayWebhooks))
* [Sending Domains](/docs/resources/sendingDomains.md) - `client.sendingDomains` ([examples](/examples/sendingDomains))
Expand Down
24 changes: 24 additions & 0 deletions docs/resources/events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Events

This library provides easy access to the [Events](https://developers.sparkpost.com/api/events) resource.

*Note: All methods return promises and accept an optional last argument callback. [Read about how we handle callbacks and promises](/docs/async.md).*

## Methods
* **searchMessage([params, callback])**<br />
Search for events of type message using the given parameters (NOTE: all params are optional):
* `params` - a hash of [Events URI Parameters](https://developers.sparkpost.com/api/events.html#events-get-search-for-message-events)

## Date/Time Parameter Format

The `from` and `to` search parameters accept date stamps of the form:

`YYYY-MM-DDTHH:MM`

For example: `2016-11-14T16:15`.

Note: timestamps are expressed in the timezone specified by the `timezone` parameter or UTC by default.

## Examples

Visit our examples section to see all of [our events resource examples](/examples/events).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sparkpost",
"version": "2.1.3",
"version": "2.1.4",
"description": "A Node.js wrapper for interfacing with your favorite SparkPost APIs",
"main": "./lib/sparkpost.js",
"scripts": {
Expand Down

0 comments on commit 51836f4

Please sign in to comment.