:meth:atomx.Atomx.report takes name parameter to name reports

Author: dakra

CHANGES.txt

@@ -1,3 +1,9 @@
+1.5 (unreleased)
+----------------
+
+- :meth:`atomx.Atomx.report` takes ``name`` parameter to name reports
+
+
 1.4
 ---
 
@@ -22,6 +28,7 @@
 - Add `save_response` parameter to :class:`atomx.Atomx` to save the response meta data
   of the last api call
 
+
 1.2
 ---
 

atomx/__init__.py

@@ -132,7 +132,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', emails=None, fast=True, when=None, interval=None):
+               timezone='UTC', emails=None, fast=True, when=None, interval=None, name=None):
         """Create a report.
 
         See the `reporting atomx wiki <https://wiki.atomx.com/reporting>`_
@@ -167,10 +167,13 @@ def report(self, scope=None, groups=None, metrics=None, where=None, from_=None,
             to speed up the query.
         :param str when: When should the scheduled report run. (daily, monthly, monday-sunday)
         :param str interval: Time period included in the scheduled report ('N days' or 'N month')
+        :param str name: Optional name for the report
         :return: A :class:`atomx.models.Report` model
         """
         report_json = {'timezone': timezone, 'fast': fast}
 
+        if name:
+            report_json['name'] = name
         if groups:
             report_json['groups'] = groups
         if metrics:

atomx/models.py

@@ -216,7 +216,7 @@ class Report(object):
     """Represents a `report` you get back from :meth:`atomx.Atomx.report`."""
 
     def __init__(self, session, query, fast, id, lines, error, link,
-                 started, finished, is_ready, duration, **kwargs):
+                 started, finished, is_ready, duration, name, **kwargs):
         self.session = session
         self.query = query
         self.fast = fast
@@ -227,6 +227,7 @@ def __init__(self, session, query, fast, id, lines, error, link,
         self.started = started
         self.finished = finished
         self.duration = duration
+        self.name = name
 
         if is_ready:
             self._is_ready = is_ready

atomx/version.py

@@ -1,2 +1,2 @@
-VERSION = '1.4'
+VERSION = '1.5b'
 API_VERSION = 'v2'