Updated SparkPost References and updated docs and mappings to reflect

beardyman · beardyman · commit 638798a8fa04 · 2014-11-10T14:40:51.000-05:00
updated config lists.
diff --git a/README.md b/README.md
@@ -47,6 +47,30 @@ try {
     * [Transmissions](https://github.com/MessageSystems/php-sdk/tree/master/examples/transmission/)
 * Read our REST API documentation - <http://www.sparkpost.com/docs/introduction>
 
+## Field Descriptions
+### Transmissions
+| Field Name       | Required?   | Description                                                                                                                | Data Type        |
+| ------------     | ----------- | -------------                                                                                                              | -----------      |
+| description      | no          | Field for describing what this transmission is for the user                                                                | String           |
+| campaign         | no          | Field for assigning a given transmission to a specific campaign, which is a logical container for similar transmissions    | String           |
+| metadata         | no          | Field for adding arbitrary key/value pairs which will be included in open/click tracking                                   | Object (Simple)  |
+| substitutionData | no          | Field for adding transmission level substitution data, which can be used in a variety of fields and in content             | Object (Complex) |
+| trackOpens       | no          | Field for enabling/disabling transmission level open tracking  (default: true)                                             | Boolean          |
+| trackClicks      | no          | Field for enabling/disabling transmission level click tracking (default: true)                                             | Boolean          |
+| useDraftTemplate | no          | Field for allowing the sending of a transmission using a draft of a stored template (default: false)                       | Boolean          |
+| replyTo          | no          | Field for specifying the email address that should be used when a recipient hits the reply button                          | String           |
+| subject          | yes         | Field for setting the subject line of a given transmission                                                                 | String           |
+| from             | yes         | Field for setting the from line of a given transmission                                                                    | String or Object |
+| html             | yes**       | Field for setting the HTML content of a given transmission                                                                 | String           |
+| text             | yes**       | Field for setting the Plain Text content of a given transmission                                                           | String           |
+| rfc822           | no**        | Field for setting the RFC-822 encoded content of a given transmission                                                      | String           |
+| template         | no**        | Field for specifying the Template ID of a stored template to be used when sending a given transmission                     | String           |
+| customHeaders    | no          | Field for specifying additional headers to be applied to a given transmission (other than Subject, From, To, and Reply-To) | Object (Simple)  |
+| recipients       | yes**       | Field for specifying who a given transmission should be sent to                                                            | Array of Objects |
+| recipientList    | no**        | Field for specifying a stored recipient list ID to be used for a given transmission                                        | String           |
+
+** - If using inline content then html or text are required. If using RFC-822 Inline Content, then rfc822 is required. If using a stored recipient list, then recipientList is required. If using a stored template, then template is required.
+
 ## Tips and Tricks
 ### General
 * You _must_ provide at least an API key when instantiating the SparkPost Library - `[ 'key'=>'184ac5480cfdd2bb2859e4476d2e5b1d2bad079bf' ]`
diff --git a/composer.json b/composer.json
@@ -1,10 +1,10 @@
 {
-    "name": "messagesystems/php-sdk",
+    "name": "sparkpost/php-sdk",
     "description": "SDK for interfacing with messagesystems APIs",
-    "license": "Apache",
+    "license": "Apache 2.0",
     "authors": [
         {
-            "name": "Message Systems",
+            "name": "Message Systems, Inc.",
             "email": "info@messagesystems.com"
         }
     ],
@@ -19,7 +19,7 @@
     },
     "autoload": {
     	"psr-4": {
-    		"MessageSystems\\": "lib/MessageSystems/"
+    		"SparkPost\\": "lib/SparkPost/"
     	}
     }
 }
diff --git a/composer.lock b/composer.lock
diff --git a/examples/transmission/configuration_based.php b/examples/transmission/configuration_based.php
@@ -2,15 +2,14 @@
 namespace Examples\Transmisson;	
 require_once (dirname(__FILE__).'/../bootstrap.php');
 
-use MessageSystems\SparkPost;
-use MessageSystems\Transmission;
+use SparkPost\SparkPost;
+use SparkPost\Transmission;
 
 $key = 'YOURAPIKEY'; 
 SparkPost::setConfig(['key'=>$key]);
 
 try {
 	$results = Transmission::send([
-		"returnPath"=>"return@example.com",
 		"from"=>"From Envelope <from@example.com>",
   		"html"=>"<p>Hello World!</p>",
   		"text"=>"Hello World!",
diff --git a/examples/transmission/get_all_transmissions.php b/examples/transmission/get_all_transmissions.php
@@ -2,8 +2,8 @@
 namespace Examples\Transmisson;
 require_once (dirname(__FILE__).'/../bootstrap.php');
 
-use MessageSystems\SparkPost;
-use MessageSystems\Transmission;
+use SparkPost\SparkPost;
+use SparkPost\Transmission;
 
 $key = 'YOURAPIKEY'; 
 SparkPost::setConfig(['key'=>$key]);
diff --git a/examples/transmission/get_transmission.php b/examples/transmission/get_transmission.php
@@ -1,8 +1,8 @@
 <?php
 namespace Examples\Transmisson;
 require_once (dirname(__FILE__).'/../bootstrap.php');
-use MessageSystems\SparkPost;
-use MessageSystems\Transmission;
+use SparkPost\SparkPost;
+use SparkPost\Transmission;
 
 $key = 'YOURAPIKEY'; 
 SparkPost::setConfig(['key'=>$key]);
diff --git a/examples/transmission/rfc822.php b/examples/transmission/rfc822.php
@@ -1,8 +1,8 @@
 <?php
 namespace Examples\Transmisson;
 require_once (dirname(__FILE__).'/../bootstrap.php');
-use MessageSystems\SparkPost;
-use MessageSystems\Transmission;
+use SparkPost\SparkPost;
+use SparkPost\Transmission;
 
 $key = 'YOURAPIKEY'; 
 SparkPost::setConfig(['key'=>$key]);
diff --git a/examples/transmission/send_transmission_all_fields.php b/examples/transmission/send_transmission_all_fields.php
@@ -1,8 +1,8 @@
 <?php
 namespace Examples\Transmisson;
 require_once (dirname(__FILE__).'/../bootstrap.php');
-use MessageSystems\SparkPost;
-use MessageSystems\Transmission;
+use SparkPost\SparkPost;
+use SparkPost\Transmission;
 
 $key = 'YOURAPIKEY';
 SparkPost::setConfig(['key'=>$key]);
@@ -19,11 +19,11 @@
 	  ],
 	  "description"=>"my description",
 	  "replyTo"=>"reply@test.com",
-	  "headers"=>[
+	  "CustomHeaders"=>[
 	    "X-Custom-Header"=>"Sample Custom Header"
 	  ],
-	  "openTracking"=>false,
-	  "clickTracking"=>false,
+	  "trackOpens"=>false,
+	  "trackClicks"=>false,
 	  "from"=>"From Envelope <from@example.com>",
 	  "html"=>"<p>Hello World! Your name is: {{name}}</p>",
 	  "text"=>"Hello World!",
diff --git a/examples/transmission/stored_recipients_inline_content.php b/examples/transmission/stored_recipients_inline_content.php
@@ -1,8 +1,8 @@
 <?php
 namespace Examples\Transmisson;
 require_once (dirname(__FILE__).'/../bootstrap.php');
-use MessageSystems\SparkPost;
-use MessageSystems\Transmission;
+use SparkPost\SparkPost;
+use SparkPost\Transmission;
 
 $key = 'YOURAPIKEY'; 
 SparkPost::setConfig(['key'=>$key]);
diff --git a/examples/transmission/stored_template_send.php b/examples/transmission/stored_template_send.php
@@ -1,8 +1,8 @@
 <?php
 namespace Examples\Transmisson;
 require_once (dirname(__FILE__).'/../bootstrap.php');
-use MessageSystems\SparkPost;
-use MessageSystems\Transmission;
+use SparkPost\SparkPost;
+use SparkPost\Transmission;
 
 $key = 'YOURAPIKEY'; 
 SparkPost::setConfig(['key'=>$key]);
diff --git a/lib/SparkPost/SparkPost.php b/lib/SparkPost/SparkPost.php
@@ -1,5 +1,5 @@
 <?php
-namespace MessageSystems;
+namespace SparkPost;
 
 class SparkPost {
 	
diff --git a/lib/SparkPost/Transmission.php b/lib/SparkPost/Transmission.php
@@ -1,5 +1,5 @@
 <?php
-namespace MessageSystems;
+namespace SparkPost;
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\RequestException;
 
@@ -29,12 +29,12 @@ class Transmission {
 		'html'=>'content.html',
 		'text'=>'content.text',
 		'rfc822Part'=>'content.email_rfc822',
-		'headers'=>'content.headers',
+		'customHeaders'=>'content.headers',
 		'recipients'=>'recipients',
 		'recipientList'=>'recipients.list_id',
 		'template'=>'content.template_id',
-		'openTracking'=>'options.open_tracking',
-		'clickTracking'=>'options.click_tracking',
+		'trackOpens'=>'options.open_tracking',
+		'trackClicks'=>'options.click_tracking',
 		'useDraftTemplate'=>'use_draft_template'
 	];
 	
@@ -114,12 +114,12 @@ private static function getBaseUrl($config) {
 	 *	'html': string,
 	 *	'text': string,
 	 *	'rfc822Part': string,
-	 *	'headers': array,
+	 *	'customHeaders': array,
 	 *	'recipients': array,
 	 *	'recipientList': string,
 	 *	'template': string,
-	 *	'openTracking': boolean,
-	 *	'clickTracking': boolean,
+	 *	'trackOpens': boolean,
+	 *	'trackClicks': boolean,
 	 *	'useDraftTemplate': boolean 
 	 *
 	 * @return array API repsonse represented as key-value pairs
diff --git a/test/unit/SparkPostTest.php b/test/unit/SparkPostTest.php
@@ -1,15 +1,15 @@
 <?php
 namespace SparkPost\Test;
 
-use MessageSystems\SparkPost;
+use SparkPost\SparkPost;
 
 class SparkPostTest extends \PHPUnit_Framework_TestCase {
 	
 	/**
 	 * @desc Ensures that the configuration class is not instantiable.
 	 */
 	public function testConstructorCannotBeCalled() {
-		$class = new \ReflectionClass('\MessageSystems\SparkPost');
+		$class = new \ReflectionClass('\SparkPost\SparkPost');
 		$this->assertFalse($class->isInstantiable()); 
 	}
 	
diff --git a/test/unit/TransmissionTest.php b/test/unit/TransmissionTest.php
@@ -1,8 +1,8 @@
 <?php
 namespace SparkPost\Test;
 
-use MessageSystems\Transmission;
-use MessageSystems\SparkPost;
+use SparkPost\Transmission;
+use SparkPost\SparkPost;
 use GuzzleHttp\Subscriber\Mock;
 use GuzzleHttp\Message\Response;
 use GuzzleHttp\Stream\Stream;
@@ -21,7 +21,7 @@ class TransmissionTest extends \PHPUnit_Framework_TestCase {
 	 * @return ReflectionMethod
 	 */
 	private static function getMethod($name) {
-		$class = new \ReflectionClass('\MessageSystems\Transmission');
+		$class = new \ReflectionClass('\SparkPost\Transmission');
 		$method = $class->getMethod($name);
 		$method->setAccessible(true);
 		return $method;
@@ -41,7 +41,7 @@ public function setUp() {
 	 * @desc Ensures that the configuration class is not instantiable.
 	 */
 	public function testConstructorCannotBeCalled() {
-		$class = new \ReflectionClass('\MessageSystems\Transmission');
+		$class = new \ReflectionClass('\SparkPost\Transmission');
 		$this->assertFalse($class->isInstantiable());
 	}
 	

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`	`1`	`{`
`2`		`- "name": "messagesystems/php-sdk",`
	`2`	`+ "name": "sparkpost/php-sdk",`
`3`	`3`	`"description": "SDK for interfacing with messagesystems APIs",`
`4`		`- "license": "Apache",`
	`4`	`+ "license": "Apache 2.0",`
`5`	`5`	`"authors": [`
`6`	`6`	`{`
`7`		`- "name": "Message Systems",`
	`7`	`+ "name": "Message Systems, Inc.",`
`8`	`8`	`"email": "[email protected]"`
`9`	`9`	`}`
`10`	`10`	`],`
`@@ -19,7 +19,7 @@`
`19`	`19`	`},`
`20`	`20`	`"autoload": {`
`21`	`21`	`"psr-4": {`
`22`		`- "MessageSystems\\": "lib/MessageSystems/"`
	`22`	`+ "SparkPost\\": "lib/SparkPost/"`
`23`	`23`	`}`
`24`	`24`	`}`
`25`	`25`	`}`