updating with review comments

Author: pmajali

linode_api4/groups/__init__.py

@@ -10,7 +10,7 @@
 from .lke import *
 from .lke_tier import *
 from .longview import *
-from .monitor import *
+from .monitor_service import *
 from .networking import *
 from .nodebalancer import *
 from .object_storage import *

linode_api4/groups/monitor.py renamed to linode_api4/groups/monitor_service.py

@@ -1,30 +1,26 @@
 from linode_api4.errors import UnexpectedResponseError
 from linode_api4.groups import Group
 from linode_api4.objects import (
-    CreateToken,
-    Dashboard,
-    DashboardByService,
-    MetricDefinition,
-    MonitorServiceSupported,
-    ServiceDetails,
+    MonitorDashboard,
+    MonitorMetricsDefinition,
+    MonitorService,
+    MonitorServiceToken,
 )
 
 
 class MonitorGroup(Group):
     """
-    Encapsulates Monitor-related methods of the :any:`LinodeClient`.  This
-    should not be instantiated on its own, but should instead be used through
-    an instance of :any:`LinodeClient`::
-
-       client = LinodeClient(token)
-       instances = client.monitor.dashboards() # use the LKEGroup
+    Encapsulates Monitor-related methods of the :any:`LinodeClient`.  
 
     This group contains all features beneath the `/monitor` group in the API v4.
     """
 
-    def dashboards(self, *filters):
+    def list_monitor_dashboards(self, *filters) -> list[MonitorDashboard]:
         """
-        Returns a list of dashboards on your account.
+        Returns a list of dashboards.
+
+            dashboards = client.monitor_service.list_monitor_dashboards()
+            dashboard = client.load(Dashboard, 1)
 
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
 
@@ -37,34 +33,41 @@ def dashboards(self, *filters):
         :returns: A list of Dashboards.
         :rtype: PaginatedList of Dashboard
         """
-        return self.client._get_and_filter(Dashboard, *filters)
 
-    def dashboards_by_service(self, service_type: str, *filters):
-        """
-        Returns a dashboards on your account based on the service passed.
+        return self.client._get_and_filter(MonitorDashboard, *filters)
 
+    def list_dashboards_by_service(self, service_type: str, *filters) -> list[MonitorDashboard]:
+        """
+        Returns a list of dashboards for a particular service.
+            
+            dashboard_by_service = client.monitor_service.list_dashboards_by_service(service_type="dbaas")
+        
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
 
         API Documentation: https://techdocs.akamai.com/linode-api/reference/get-dashboards
 
+        :param service_type: The service type to get dashboards for.
+        :type service_type: str
         :param filters: Any number of filters to apply to this query.
                         See :doc:`Filtering Collections</linode_api4/objects/filtering>`
                         for more details on filtering.
 
-        :returns: A Dashboards filtered by Service Type.
+        :returns: Dashboards filtered by Service Type.
         :rtype: PaginatedList of the Dashboards
         """
 
         return self.client._get_and_filter(
-            DashboardByService,
+            MonitorDashboard,
             *filters,
             endpoint=f"/monitor/services/{service_type}/dashboards",
         )
 
-    def supported_services(self, *filters):
+    def list_supported_services(self, *filters) -> list[MonitorService]:
         """
         Returns a list of services supported by ACLP.
 
+            supported_services = client.monitor_service.list_supported_services()
+        
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
 
         API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services
@@ -74,63 +77,74 @@ def supported_services(self, *filters):
                         for more details on filtering.
 
         :returns: A list of Supported Services
-        :rtype: PaginatedList of the Dashboards
+        :rtype: PaginatedList of Services
         """
 
-        return self.client._get_and_filter(MonitorServiceSupported, *filters)
+        return self.client._get_and_filter(MonitorService, *filters)
 
-    def details_by_service(self, service_type: str, *filters):
+    def list_service_by_type(self, service_type: str, *filters) -> list[MonitorService]:
         """
-        Returns a details about a particular service.
+        Lists monitor services by a given service_type
 
+            service_details = client.monitor_service.list_service_by_type(service_type="dbaas")
+        
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
-
+        
         API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-services-for-service-type
-
+        
+        :param service_type: The service type to get details for.
+        :type service_type: str
         :param filters: Any number of filters to apply to this query.
                         See :doc:`Filtering Collections</linode_api4/objects/filtering>`
                         for more details on filtering.
-
-        :returns: Details about a  Supported Services
-        :rtype: PaginatedList of the Service
+        
+        :returns: Lists monitor services by a given service_type
+        :rtype: PaginatedList of the Services
         """
         return self.client._get_and_filter(
-            ServiceDetails,
+            MonitorService,
             *filters,
             endpoint=f"/monitor/services/{service_type}",
         )
 
-    def metric_definitions(self, service_type: str, *filters):
+
+    def list_metric_definitions(self, service_type: str, *filters) -> list[MonitorMetricsDefinition]:
         """
         Returns metrics for a specific service type.
 
+            metrics = client.monitor_service.list_metric_definitions(service_type="dbaas")
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
 
         API Documentation: https://techdocs.akamai.com/linode-api/reference/get-monitor-information
 
+        :param service_type: The service type to get metrics for.
+        :type service_type: str
         :param filters: Any number of filters to apply to this query.
                         See :doc:`Filtering Collections</linode_api4/objects/filtering>`
                         for more details on filtering.
 
-        :returns: Returns a  List of metrics for a service
+        :returns: Returns a List of metrics for a service
         :rtype: PaginatedList of metrics
         """
         return self.client._get_and_filter(
-            MetricDefinition,
+            MonitorMetricsDefinition,
             *filters,
             endpoint=f"/monitor/services/{service_type}/metric-definitions",
         )
 
-    def create_token(self, service_type: str, entity_ids: list, *filters):
+    def create_token(self, service_type: str, entity_ids: list) -> MonitorServiceToken:
         """
         Returns a JWE Token for a specific service type.
+            token = client.monitor_service.create_token(service_type="dbaas", entity_ids=[1234])
 
         .. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
 
         API Documentation: https://techdocs.akamai.com/linode-api/reference/post-get-token
-        :param filters: Any number of filters to apply to this query.
-                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
-                        for more details on filtering.
+        
+        :param service_type: The service type to create token for.
+        :type service_type: str
+        :param entity_ids: The list of entity IDs for which the token is valid.
+        :type entity_ids: list of int
 
         :returns: Returns a token for a service
         :rtype: str
@@ -146,4 +160,5 @@ def create_token(self, service_type: str, entity_ids: list, *filters):
             raise UnexpectedResponseError(
                 "Unexpected response when creating token!", json=result
             )
-        return CreateToken(self.client, result["token"], result)
+        return MonitorServiceToken(token=result["token"])
+        

linode_api4/linode_client.py

@@ -202,7 +202,7 @@ def __init__(
         #: Access methods related to VM placement - See :any:`PlacementAPIGroup` for more information.
         self.placement = PlacementAPIGroup(self)
 
-        self.monitor = MonitorGroup(self)
+        self.monitor_service = MonitorGroup(self)
 
     @property
     def _user_agent(self):

linode_api4/objects/__init__.py

@@ -21,4 +21,4 @@
 from .vpc import *
 from .beta import *
 from .placement import *
-from .monitor import *
+from .monitor_service import *