summaryrefslogtreecommitdiffstats
path: root/lib/SparkPost
diff options
context:
space:
mode:
authorJames Fellows <james.fellows@finanscapes.com>2016-04-26 21:05:06 +0100
committerJames Fellows <james.fellows@finanscapes.com>2016-04-26 21:05:06 +0100
commit4ee945d21af22df681882887db0a6082bfbe371a (patch)
treec5db615538fce7f598cf02f9bf120122d05dd940 /lib/SparkPost
parent6aeb9680c743ce71994bcddb59adfd18ccfe98a0 (diff)
downloadphp-sparkpost-4ee945d21af22df681882887db0a6082bfbe371a.zip
php-sparkpost-4ee945d21af22df681882887db0a6082bfbe371a.tar.gz
php-sparkpost-4ee945d21af22df681882887db0a6082bfbe371a.tar.bz2
Rename MessageEvent to plural, update docblocks.
Diffstat (limited to 'lib/SparkPost')
-rw-r--r--lib/SparkPost/MessageEvents.php (renamed from lib/SparkPost/MessageEvent.php)12
-rw-r--r--lib/SparkPost/SparkPost.php4
2 files changed, 12 insertions, 4 deletions
diff --git a/lib/SparkPost/MessageEvent.php b/lib/SparkPost/MessageEvents.php
index d2fe11c..788b752 100644
--- a/lib/SparkPost/MessageEvent.php
+++ b/lib/SparkPost/MessageEvents.php
@@ -6,8 +6,11 @@ namespace SparkPost;
*
* @see https://developers.sparkpost.com/api/#/reference/message-events
*/
-class MessageEvent extends APIResource
+class MessageEvents extends APIResource
{
+ /**
+ * @var string
+ */
public $endpoint = 'message-events';
/**
@@ -45,8 +48,13 @@ class MessageEvent extends APIResource
/**
* List examples of the event data that will be included in a response from the MessageEvent::search() method.
+ *
+ * @param array $events (optional) Event types for which to get a sample payload. If not provided, samples
+ * for all events will be returned.
+ *
+ * @return array Sample events.
*/
- public function samples(Array $events) {
+ public function samples(Array $events = []) {
return $this->get("events/samples", ["events"=>$events]);
}
} \ No newline at end of file
diff --git a/lib/SparkPost/SparkPost.php b/lib/SparkPost/SparkPost.php
index 0e576fe..48d6a9c 100644
--- a/lib/SparkPost/SparkPost.php
+++ b/lib/SparkPost/SparkPost.php
@@ -6,7 +6,7 @@ use Ivory\HttpAdapter\HttpAdapterInterface;
class SparkPost {
public $transmission;
- public $messageEvent;
+ public $messageEvents;
/**
* Connection config for making requests.
@@ -46,7 +46,7 @@ class SparkPost {
$this->setHttpAdapter($httpAdapter);
$this->transmission = new Transmission($this);
- $this->messageEvent = new MessageEvent($this);
+ $this->messageEvents = new MessageEvents($this);
}
/**