Add emails parameter to :meth:atomx.Atomx.report

Author: dakra

CHANGES.txt

@@ -1,26 +1,28 @@
 1.3 (unreleased)
 ----------------
 
-- add :meth:`atomx.Atomx.delete` to send a ``HTTP DELETE`` request to the api
+- Add :meth:`atomx.Atomx.delete` to send a ``HTTP DELETE`` request to the api
 - :meth:`atomx.Atomx.get` and :meth:`atomx.Atomx.delete` accept non-keyword arguments
-    that are used to compute the final resource path.
+    that are used to compute the final resource path
+- Add `emails` parameter to :meth:`atomx.Atomx.report`
+
 
 1.2
 ---
 
-- you can now remove model attributes with `del`
-- add :meth:`atomx.models.Report.csv` property that returns the report content as a list
-- save logged in user as `user` property to :class:`atomx.Atomx`
-- add network reports
-- try to determine report scope from user access rights if no scope was specified
+- You can now remove model attributes with `del`
+- Add :meth:`atomx.models.Report.csv` property that returns the report content as a list
+- Save logged in user as `user` property to :class:`atomx.Atomx`
+- Add network reports
+- Try to determine report scope from user access rights if no scope was specified
 
 
 1.1
 ---
 
-- fix: setup.py not working under some environments (`open` used wrong codec)
-- add SellerProfile model
-- add `offset` parameter to report.get
+- Fix: setup.py not working under some environments (`open` used wrong codec)
+- Add SellerProfile model
+- Add `offset` parameter to :meth:`atomx.models.Report.get`
 
 
 1.0

atomx/__init__.py

@@ -121,7 +121,7 @@ def search(self, query):
         return search_result
 
     def report(self, scope=None, groups=None, metrics=None, where=None,
-               from_=None, to=None, timezone='UTC', fast=True):
+               from_=None, to=None, timezone='UTC', emails=None, fast=True):
         """Create a report.
 
         See the `reporting atomx wiki <http://wiki.atomx.com/doku.php?id=reporting>`_
@@ -147,6 +147,9 @@ def report(self, scope=None, groups=None, metrics=None, where=None,
             should end (exclusive). (defaults to `datetime.now()` if undefined)
         :param str timezone:  Timezone used for all times. (defaults to `UTC`)
             For a supported list see http://wiki.atomx.com/doku.php?id=timezones
+        :param emails: One or multiple email addresses that should get
+            notified once the report is finished and ready to download.
+        :type emails: str or list
         :param bool fast: if `False` the report will always be run against the low level data.
             This is useful for billing reports for example.
             The default is `True` which means it will always try to use aggregate data
@@ -198,6 +201,11 @@ def report(self, scope=None, groups=None, metrics=None, where=None,
         else:
             report_json['to'] = to
 
+        if emails:
+            if not isinstance(emails, list):
+                emails = [emails]
+            report_json['emails'] = emails
+
         r = self.session.post(self.api_endpoint + 'report', json=report_json)
         if not r.ok:
             raise APIError(r.json()['error'])