File tree 4 files changed +31
-1
lines changed
4 files changed +31
-1
lines changed Original file line number Diff line number Diff line change @@ -5,6 +5,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
5
5
## [ Unreleased] [ unreleased ]
6
6
- Security patches to dev-dependencies [ #237 ] ( https://github.com/SparkPost/node-sparkpost/pull/237 ) by @jgzamora
7
7
8
+ ## [ 2.1.4] - 2019-10-01
9
+ ### Added
10
+ - Events API functionality by @sstaley-sparkpost
11
+ - Example for [ searching the events/message API] ( /examples/events/search_message.js ) by @sstaley-sparkpost .
12
+
8
13
## [ 2.1.3] - 2018-10-24
9
14
### Fixed
10
15
- Template preview draft option [ bug] ( https://github.com/SparkPost/node-sparkpost/issues/233 ) by @jgzamora
Original file line number Diff line number Diff line change @@ -153,6 +153,7 @@ Click on the desired API to see usage and more information
153
153
154
154
* [ Inbound Domains] ( /docs/resources/inboundDomains.md ) - ` client.inboundDomains ` ([ examples] ( /examples/inboundDomains ) )
155
155
* [ Message Events] ( /docs/resources/messageEvents.md ) - ` client.messageEvents ` ([ examples] ( /examples/messageEvents ) )
156
+ * [ Events] ( /docs/resources/events.md ) - ` client.events ` ([ examples] ( /examples/events ) )
156
157
* [ Recipient Lists] ( /docs/resources/recipientLists.md ) - ` client.recipientLists ` ([ examples] ( /examples/recipientLists ) )
157
158
* [ Relay Webhooks] ( /docs/resources/relayWebhooks.md ) - ` client.relayWebhooks ` ([ examples] ( /examples/relayWebhooks ) )
158
159
* [ Sending Domains] ( /docs/resources/sendingDomains.md ) - ` client.sendingDomains ` ([ examples] ( /examples/sendingDomains ) )
Original file line number Diff line number Diff line change
1
+ # Events
2
+
3
+ This library provides easy access to the [ Events] ( https://developers.sparkpost.com/api/events ) resource.
4
+
5
+ * Note: All methods return promises and accept an optional last argument callback. [ Read about how we handle callbacks and promises] ( /docs/async.md ) .*
6
+
7
+ ## Methods
8
+ * ** searchMessage([ params, callback] )** <br />
9
+ Search for events of type message using the given parameters (NOTE: all params are optional):
10
+ * ` params ` - a hash of [ Events URI Parameters] ( https://developers.sparkpost.com/api/events.html#events-get-search-for-message-events )
11
+
12
+ ## Date/Time Parameter Format
13
+
14
+ The ` from ` and ` to ` search parameters accept date stamps of the form:
15
+
16
+ ` YYYY-MM-DDTHH:MM `
17
+
18
+ For example: ` 2016-11-14T16:15 ` .
19
+
20
+ Note: timestamps are expressed in the timezone specified by the ` timezone ` parameter or UTC by default.
21
+
22
+ ## Examples
23
+
24
+ Visit our examples section to see all of [ our events resource examples] ( /examples/events ) .
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " sparkpost" ,
3
- "version" : " 2.1.3 " ,
3
+ "version" : " 2.1.4 " ,
4
4
"description" : " A Node.js wrapper for interfacing with your favorite SparkPost APIs" ,
5
5
"main" : " ./lib/sparkpost.js" ,
6
6
"scripts" : {
You can’t perform that action at this time.
0 commit comments