[dashboard list] Add new endpoints + dog cmd for dashboard lists

datadog/api/__init__.py

@@ -18,6 +18,7 @@
 
 # Resources
 from datadog.api.comments import Comment
+from datadog.api.dashboard_lists import DashboardList
 from datadog.api.downtimes import Downtime
 from datadog.api.timeboards import Timeboard
 from datadog.api.events import Event

datadog/api/dashboard_lists.py

@@ -0,0 +1,67 @@
+from datadog.api.resources import (
+    ActionAPIResource,
+    CreateableAPIResource,
+    DeletableAPIResource,
+    GetableAPIResource,
+    ListableAPIResource,
+    UpdatableAPIResource
+)
+
+
+class DashboardList(ActionAPIResource, CreateableAPIResource, DeletableAPIResource,
+                    GetableAPIResource, ListableAPIResource, UpdatableAPIResource):
+    """
+    A wrapper around Dashboard List HTTP API.
+    """
+    _class_url = '/dashboard/lists/manual'
+
+    @classmethod
+    def get_dashboards(cls, id, **params):
+        """
+        Get dashboards for a dashboard list.
+
+        :returns: Dictionary representing the API's JSON response
+        """
+        return super(DashboardList, cls)._trigger_class_action('GET', 'dashboards', id, params)
+
+    @classmethod
+    def add_dashboards(cls, id, **body):
+        """
+        Add dashboards to a dashboard list.
+
+        :param dashboards: dashboards to add to the dashboard list
+        :type dashboards: list of dashboard dicts, e.g. [{"type": "custom_timeboard", "id": 1104}]
+
+        :returns: Dictionary representing the API's JSON response
+        """
+        return super(DashboardList, cls)._trigger_class_action(
+            'POST', 'dashboards', id, params=None, **body
+        )
+
+    @classmethod
+    def update_dashboards(cls, id, **body):
+        """
+        Update dashboards of a dashboard list.
+
+        :param dashboards: dashboards of the dashboard list
+        :type dashboards: list of dashboard dicts, e.g. [{"type": "custom_timeboard", "id": 1104}]
+
+        :returns: Dictionary representing the API's JSON response
+        """
+        return super(DashboardList, cls)._trigger_class_action(
+            'PUT', 'dashboards', id, params=None, **body
+        )
+
+    @classmethod
+    def delete_dashboards(cls, id, **body):
+        """
+        Delete dashboards from a dashboard list.
+
+        :param dashboards: dashboards to delete from the dashboard list
+        :type dashboards: list of dashboard dicts, e.g. [{"type": "custom_timeboard", "id": 1234}]
+
+        :returns: Dictionary representing the API's JSON response
+        """
+        return super(DashboardList, cls)._trigger_class_action(
+            'DELETE', 'dashboards', id, params=None, **body
+        )

datadog/api/hosts.py

@@ -8,7 +8,7 @@ class Host(ActionAPIResource):
     _class_url = '/host'
 
     @classmethod
-    def mute(cls, host_name, **params):
+    def mute(cls, host_name, **body):
         """
         Mute a host.
 
@@ -28,7 +28,7 @@ def mute(cls, host_name, **params):
         :returns: Dictionary representing the API's JSON response
 
         """
-        return super(Host, cls)._trigger_class_action('POST', 'mute', host_name, **params)
+        return super(Host, cls)._trigger_class_action('POST', 'mute', host_name, **body)
 
     @classmethod
     def unmute(cls, host_name):

datadog/api/monitors.py

@@ -57,7 +57,7 @@ def get_all(cls, **params):
         return super(Monitor, cls).get_all(**params)
 
     @classmethod
-    def mute(cls, id, **params):
+    def mute(cls, id, **body):
         """
         Mute a monitor.
 
@@ -70,10 +70,10 @@ def mute(cls, id, **params):
 
         :returns: Dictionary representing the API's JSON response
         """
-        return super(Monitor, cls)._trigger_class_action('POST', 'mute', id, **params)
+        return super(Monitor, cls)._trigger_class_action('POST', 'mute', id, **body)
 
     @classmethod
-    def unmute(cls, id, **params):
+    def unmute(cls, id, **body):
         """
         Unmute a monitor.
 
@@ -85,7 +85,7 @@ def unmute(cls, id, **params):
 
         :returns: Dictionary representing the API's JSON response
         """
-        return super(Monitor, cls)._trigger_class_action('POST', 'unmute', id, **params)
+        return super(Monitor, cls)._trigger_class_action('POST', 'unmute', id, **body)
 
     @classmethod
     def mute_all(cls):

datadog/api/resources.py

@@ -169,7 +169,7 @@ class ActionAPIResource(object):
     Actionable API Resource
     """
     @classmethod
-    def _trigger_class_action(cls, method, name, id=None, **params):
+    def _trigger_class_action(cls, method, name, id=None, params=None, **body):
         """
         Trigger an action
 
@@ -185,15 +185,22 @@ def _trigger_class_action(cls, method, name, id=None, **params):
         :param params: action parameters
         :type params: dictionary
 
+        :param body: action body
+        :type body: dictionary
+
         :returns: Dictionary representing the API's JSON response
         """
+        if params is None:
+            params = {}
         if id is None:
-            return APIClient.submit(method, cls._class_url + "/" + name, params)
+            return APIClient.submit(method, cls._class_url + "/" + name, body, **params)
         else:
-            return APIClient.submit(method, cls._class_url + "/" + str(id) + "/" + name, params)
+            return APIClient.submit(
+                method, cls._class_url + "/" + str(id) + "/" + name, body, **params
+            )
 
     @classmethod
-    def _trigger_action(cls, method, name, id=None, **params):
+    def _trigger_action(cls, method, name, id=None, **body):
         """
         Trigger an action
 
@@ -206,12 +213,12 @@ def _trigger_action(cls, method, name, id=None, **params):
         :param id: trigger the action for the specified resource object
         :type id: id
 
-        :param params: action parameters
-        :type params: dictionary
+        :param body: action body
+        :type body: dictionary
 
         :returns: Dictionary representing the API's JSON response
         """
         if id is None:
-            return APIClient.submit(method, name, params)
+            return APIClient.submit(method, name, body)
         else:
-            return APIClient.submit(method, name + "/" + str(id), params)
+            return APIClient.submit(method, name + "/" + str(id), body)

datadog/api/service_checks.py

@@ -8,7 +8,7 @@ class ServiceCheck(ActionAPIResource):
     A wrapper around ServiceCheck HTTP API.
     """
     @classmethod
-    def check(cls, **params):
+    def check(cls, **body):
         """
         Post check statuses for use with monitors
 
@@ -34,9 +34,9 @@ def check(cls, **params):
         """
 
         # Validate checks, include only non-null values
-        for param, value in params.items():
-            if param == 'status' and params[param] not in CheckStatus.ALL:
+        for param, value in body.items():
+            if param == 'status' and body[param] not in CheckStatus.ALL:
                 raise ApiError('Invalid status, expected one of: %s'
                                % ', '.join(str(v) for v in CheckStatus.ALL))
 
-        return super(ServiceCheck, cls)._trigger_action('POST', 'check_run', **params)
+        return super(ServiceCheck, cls)._trigger_action('POST', 'check_run', **body)

datadog/dogshell/__init__.py

@@ -8,6 +8,7 @@
 from datadog import initialize
 from datadog.dogshell.comment import CommentClient
 from datadog.dogshell.common import DogshellConfig
+from datadog.dogshell.dashboard_list import DashboardListClient
 from datadog.dogshell.downtime import DowntimeClient
 from datadog.dogshell.event import EventClient
 from datadog.dogshell.host import HostClient
@@ -56,6 +57,7 @@ def main():
     MonitorClient.setup_parser(subparsers)
     TimeboardClient.setup_parser(subparsers)
     ScreenboardClient.setup_parser(subparsers)
+    DashboardListClient.setup_parser(subparsers)
     HostClient.setup_parser(subparsers)
     DowntimeClient.setup_parser(subparsers)
     ServiceCheckClient.setup_parser(subparsers)