Rename MessageEvent to plural, update docblocks.

Author: j4m3s

CHANGELOG.md

@@ -3,7 +3,8 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
-- All content has been released to date.
+- Message Events API added.
+- Transmission API now accepts a DateTime object for startDate
 
 ## [1.0.3] - 2016-03-25
 ### Added

lib/SparkPost/MessageEvent.php renamed to lib/SparkPost/MessageEvents.php

@@ -6,8 +6,11 @@
  *
  * @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 @@ public function documentation() {
 
   /**
    * 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]);
   }
 }

lib/SparkPost/SparkPost.php

@@ -6,7 +6,7 @@
 class SparkPost {
 
   public $transmission;
-  public $messageEvent;
+  public $messageEvents;
 
   /**
    * Connection config for making requests.
@@ -46,7 +46,7 @@ public function __construct($httpAdapter, $settingsConfig) {
     $this->setHttpAdapter($httpAdapter);
 
     $this->transmission = new Transmission($this);
-    $this->messageEvent = new MessageEvent($this);
+    $this->messageEvents = new MessageEvents($this);
   }
 
   /**

test/unit/MessageEventTest.php

@@ -21,7 +21,7 @@ public function setUp()
       $mock->shouldReceive('getHttpHeaders')->andReturn([]);
     });
     $this->sparkPostMock->httpAdapter = Mockery::mock();
-    $this->sut = new MessageEvent($this->sparkPostMock);
+    $this->sut = new MessageEvents($this->sparkPostMock);
   }
 
   public function testDateTimeConversion()