Merge pull request #59 from SparkPost/issue-58

Add support for additional transmission options

Author: rajumsys

examples/transmissions/schedule_transmission.py

@@ -0,0 +1,37 @@
+from sparkpost import SparkPost
+
+sp = SparkPost()
+
+response = sp.transmission.send(
+    recipients=[
+        '[email protected]',
+        '[email protected]',
+        {
+            'address': {
+                'email': '[email protected]',
+                'name': 'John Doe'
+            }
+        }
+    ],
+    html='<p>Hello world {{name}}</p>',
+    text='Hello world {{name}}',
+    from_email='[email protected]',
+    subject='Example Script',
+    description='contrived example',
+    custom_headers={
+        'X-CUSTOM-HEADER': 'foo bar'
+    },
+    track_opens=True,
+    track_clicks=True,
+    start_time='2015-11-06T09:10:00-05:00',
+    campaign='python-sparkpost example',
+    metadata={
+        'key': 'value',
+        'arbitrary': 'values'
+    },
+    substitution_data={
+        'name': 'Example User'
+    }
+)
+
+print response

sparkpost/transmissions.py

@@ -26,9 +26,12 @@ def _translate_keys(self, **kwargs):
         model['metadata'] = kwargs.get('metadata')
         model['substitution_data'] = kwargs.get('substitution_data')
 
+        model['options']['start_time'] = kwargs.get('start_time')
         model['options']['open_tracking'] = kwargs.get('track_opens')
         model['options']['click_tracking'] = kwargs.get('track_clicks')
+        model['options']['transactional'] = kwargs.get('transactional')
         model['options']['sandbox'] = kwargs.get('use_sandbox')
+        model['options']['skip_suppression'] = kwargs.get('skip_suppression')
 
         model['content']['use_draft_template'] = \
             kwargs.get('use_draft_template', False)
@@ -83,13 +86,21 @@ def send(self, **kwargs):
         :param dict substitution_data: Corresponds to substitutions in
             html/text content. See `substitutions reference
             <https://www.sparkpost.com/docs/substitutions-reference>`_.
+        :param str start_time: Delay generation of messages until this
+            datetime. Format YYYY-MM-DDTHH:MM:SS+-HH:MM. Example:
+            '2015-02-11T08:00:00-04:00'.
         :param bool track_opens: Defaults to True. Used to track opens of
             transmission
         :param bool track_clicks: Defaults to True. Used to track clicks of
             transmission
         :param bool use_sandbox: Flag must be set to use sandbox domain instead
             of verified sending domain. Limited to a lifetime of 50
             transmissions with this domain
+        :param bool transactional: Whether message is transactional or
+            non-transactional for unsubscribe and suppression purposes
+        :param bool skip_suppression: Whether or not to ignore customer
+            suppression rules, for this transmission only. Only applicable if
+            your configuration supports this parameter. (SparkPost Elite only)
         :param dict custom_headers: Used to set any headers associated with
             transmission