Merge pull request #66 from SparkPost/ISSUE-62

Updates to documentation/examples

Author: richleland

docs/resources/transmissions.rst

@@ -9,7 +9,7 @@ Here at SparkPost, our messages are known as transmissions. Let's use the underl
 
     sp = SparkPost()
 
-    response = sp.transmission.send(
+    response = sp.transmissions.send(
         recipients=['someone@somedomain.com'],
         html='<p>Hello world</p>',
         from_email='test@sparkpostbox.com',
@@ -43,7 +43,7 @@ Using inline templates and/or recipients
 
     sp = SparkPost()
 
-    sp.transmission.send(
+    sp.transmissions.send(
         recipients=['someone@somedomain.com'],
         text="Hello world",
         html='<p>Hello world</p>',
@@ -63,7 +63,7 @@ Sending an attachment
 
     sp = SparkPost()
 
-    sp.transmission.send(
+    sp.transmissions.send(
         recipients=['someone@somedomain.com'],
         text="Hello world",
         html='<p>Hello world</p>',
@@ -81,6 +81,33 @@ Sending an attachment
     )
 
 
+Using substitution data
+***********************
+
+.. note::
+
+   Substitution data can be specified at the template, transmission and recipient levels. The order of precedence is as follows: recipient overrides transmission overrides template.
+
+.. code-block:: python
+
+    from sparkpost import SparkPost
+
+    sp = SparkPost()
+
+    sp.transmissions.send(
+        recipients=['someone@somedomain.com'],
+        text="Hello {{name}}",
+        html='<p>Hello {{name}}</p>',
+        from_email='test@sparkpostbox.com',
+        subject='Hello from python-sparkpost',
+        track_opens=True,
+        track_clicks=True,
+        substitution_data={
+            'name': 'Sparky'
+        }
+    )
+
+
 Using a stored template
 ***********************
 
@@ -90,7 +117,7 @@ Using a stored template
 
     sp = SparkPost()
 
-    sp.transmission.send(
+    sp.transmissions.send(
         recipients=['someone@somedomain.com'],
         template='my-template-id'
     )
@@ -105,7 +132,7 @@ Using a stored recipient list
 
     sp = SparkPost()
 
-    sp.transmission.send(
+    sp.transmissions.send(
         recipient_list='my-recipient-list',
         template='my-template-id'
     )
@@ -120,7 +147,7 @@ Retrieve a transmission
 
     sp = SparkPost()
 
-    sp.transmission.get('my-transmission-id')
+    sp.transmissions.get('my-transmission-id')
 
 
 List all transmissions
@@ -132,7 +159,7 @@ List all transmissions
 
     sp = SparkPost()
 
-    sp.transmission.list()
+    sp.transmissions.list()
 
 
 API reference

examples/transmissions/a-file.txt

@@ -0,0 +1 @@
+Woo hoo! This attachment was added via python-sparkpost.

examples/transmissions/send_transmission.py

@@ -1,5 +1,10 @@
+import os
+
 from sparkpost import SparkPost
 
+parent_dir = os.path.dirname(os.path.realpath(__file__))
+attachment_path = os.path.abspath(os.path.join(parent_dir, "a-file.txt"))
+
 sp = SparkPost()
 
 response = sp.transmissions.send(
@@ -13,8 +18,8 @@
             }
         }
     ],
-    html='<p>Hello world {{name}}</p>',
-    text='Hello world {{name}}',
+    html='<p>Hello {{name}}</p>',
+    text='Hello {{name}}',
     from_email='test@sparkpostbox.com',
     subject='Example Script',
     description='contrived example',
@@ -23,6 +28,13 @@
     },
     track_opens=True,
     track_clicks=True,
+    attachments=[
+        {
+            "name": "test.txt",
+            "type": "text/plain",
+            "filename": attachment_path
+        }
+    ],
     campaign='sdk example',
     metadata={
         'key': 'value',