Merge pull request #190 from PaperMtn/feat/dashboard-method-util-refactor

Feat/dashboard method util refactor

Author: mihirvala08

README.md

@@ -2930,9 +2930,13 @@ dashboard = chronicle.get_dashboard(
 print(f"Dashboard Details: {dashboard}")
 ```
 
-### List Dashboards with pagination
+### List Dashboards
 ```python
-# List dashboards (first page)
+dashboards = chronicle.list_dashboards()
+for dashboard in dashboards.get("nativeDashboards", []):
+    print(f"- {dashboard.get('displayName')}")
+
+# List dashboards with pagination(first page)
 dashboards = chronicle.list_dashboards(page_size=10)
 for dashboard in dashboards.get("nativeDashboards", []):
     print(f"- {dashboard.get('displayName')}")

src/secops/chronicle/client.py

@@ -4091,6 +4091,7 @@ def create_dashboard(
         description: str | None = None,
         filters: list[dict[str, Any]] | str | None = None,
         charts: list[dict[str, Any]] | str | None = None,
+        api_version: APIVersion | None = APIVersion.V1ALPHA,
     ) -> dict[str, Any]:
         """Create a new native dashboard.
 
@@ -4102,6 +4103,7 @@ def create_dashboard(
                 (JSON or JSON string)
             charts: List of charts to include in the dashboard
                 (JSON or JSON string)
+            api_version: Preferred API version to use. Defaults to V1ALPHA
 
         Returns:
             Dictionary containing the created dashboard details
@@ -4121,56 +4123,70 @@ def create_dashboard(
             description=description,
             filters=filters,
             charts=charts,
+            api_version=api_version,
         )
 
-    def import_dashboard(self, dashboard: dict[str, Any]) -> dict[str, Any]:
+    def import_dashboard(
+        self,
+        dashboard: dict[str, Any],
+        api_version: APIVersion | None = APIVersion.V1ALPHA,
+    ) -> dict[str, Any]:
         """Create a new native dashboard.
 
         Args:
             dashboard: ImportNativeDashboardsInlineSource
+            api_version: Preferred API version to use. Defaults to V1ALPHA
 
         Returns:
             Dictionary containing the created dashboard details
 
         Raises:
             APIError: If the API request fails
         """
+        return _import_dashboard(
+            self, dashboard=dashboard, api_version=api_version
+        )
 
-        return _import_dashboard(self, dashboard=dashboard)
-
-    def export_dashboard(self, dashboard_names: list[str]) -> dict[str, Any]:
+    def export_dashboard(
+        self,
+        dashboard_names: list[str],
+        api_version: APIVersion | None = APIVersion.V1ALPHA,
+    ) -> dict[str, Any]:
         """Export native dashboards.
         It supports single dashboard export operation only.
 
         Args:
             dashboard_names: List of dashboard resource names to export.
+            api_version: Preferred API version to use. Defaults to V1ALPHA
 
         Returns:
             Dictionary containing the exported dashboards.
 
         Raises:
             APIError: If the API request fails
         """
-
-        return _export_dashboard(self, dashboard_names=dashboard_names)
+        return _export_dashboard(
+            self, dashboard_names=dashboard_names, api_version=api_version
+        )
 
     def list_dashboards(
         self,
         page_size: int | None = None,
         page_token: str | None = None,
+        api_version: APIVersion | None = APIVersion.V1ALPHA,
         as_list: bool = False,
-    ) -> dict[str, Any] | list[dict[str, Any]]:
-        """List all available dashboards.
+    ) -> dict[str, Any]:
+        """List all available dashboards in Basic View.
 
         Args:
             page_size: Maximum number of results to return
             page_token: Token for pagination
-            as_list: If True, return a list of dashboards instead of a dict
-                with dashboards list and nextPageToken.
+            api_version: Preferred API version to use. Defaults to V1ALPHA
+            as_list: Whether to return results as a list or dictionary
 
         Returns:
             If as_list is True: List of dashboards.
-            If as_list is False: Dict with dashboards list and nextPageToken.
+            If as_list is False: Dictionary containing list of dashboards and pagination info.
 
         Raises:
             APIError: If the API request fails
@@ -4179,23 +4195,29 @@ def list_dashboards(
             self,
             page_size=page_size,
             page_token=page_token,
+            api_version=api_version,
             as_list=as_list,
         )
 
     def get_dashboard(
         self,
         dashboard_id: str,
         view: str | None = None,
+        api_version: APIVersion | None = APIVersion.V1ALPHA,
     ) -> dict[str, Any]:
         """Get information about a specific dashboard.
 
         Args:
             dashboard_id: ID of the dashboard to retrieve
             view: Level of detail to include in the response
                 Defaults to BASIC
+            api_version: Preferred API version to use. Defaults to V1ALPHA
 
         Returns:
             Dictionary containing dashboard details
+
+        Raises:
+            APIError: If the API request fails
         """
         if view:
             try:
@@ -4207,6 +4229,7 @@ def get_dashboard(
             self,
             dashboard_id=dashboard_id,
             view=view,
+            api_version=api_version,
         )
 
     def update_dashboard(
@@ -4216,6 +4239,7 @@ def update_dashboard(
         description: str | None = None,
         filters: list[dict[str, Any]] | str | None = None,
         charts: list[dict[str, Any]] | str | None = None,
+        api_version: APIVersion | None = APIVersion.V1ALPHA,
     ) -> dict[str, Any]:
         """Update an existing dashboard.
 
@@ -4225,6 +4249,7 @@ def update_dashboard(
             description: New description for the dashboard (optional)
             filters: New filters for the dashboard (optional)
             charts: New charts for the dashboard (optional)
+            api_version: Preferred API version to use. Defaults to V1ALPHA
 
         Returns:
             Dictionary containing the updated dashboard details
@@ -4236,15 +4261,29 @@ def update_dashboard(
             description=description,
             filters=filters,
             charts=charts,
+            api_version=api_version,
         )
 
-    def delete_dashboard(self, dashboard_id: str) -> dict[str, Any]:
+    def delete_dashboard(
+        self,
+        dashboard_id: str,
+        api_version: APIVersion | None = APIVersion.V1ALPHA,
+    ) -> dict[str, Any]:
         """Delete an existing dashboard.
 
         Args:
             dashboard_id: ID of the dashboard to delete
+            api_version: Preferred API version to use. Defaults to V1ALPHA
+
+        Returns:
+            Empty dictionary if deletion is successful
+
+        Raises:
+            APIError: If the API request fails
         """
-        return _delete_dashboard(self, dashboard_id=dashboard_id)
+        return _delete_dashboard(
+            self, dashboard_id=dashboard_id, api_version=api_version
+        )
 
     def add_chart(
         self,
@@ -4258,6 +4297,7 @@ def add_chart(
         description: str | None = None,
         query: str | None = None,
         interval: InputInterval | dict[str, Any] | str | None = None,
+        api_version: APIVersion | None = APIVersion.V1ALPHA,
         **kwargs,
     ) -> dict[str, Any]:
         """Add a chart to an existing dashboard.
@@ -4276,6 +4316,7 @@ def add_chart(
             description: Description for the chart
             query: Query for the chart
             interval: Query input interval for the chart
+            api_version: Preferred API version to use. Defaults to V1ALPHA
             **kwargs: Additional keyword arguments
                 (Will be added to request payload)
 
@@ -4300,6 +4341,7 @@ def add_chart(
             description=description,
             query=query,
             interval=interval,
+            api_version=api_version,
             **kwargs,
         )
 
@@ -4309,17 +4351,24 @@ def duplicate_dashboard(
         display_name: str,
         access_type: str,
         description: str | None = None,
+        api_version: APIVersion | None = APIVersion.V1ALPHA,
     ) -> dict[str, Any]:
         """Duplicate an existing dashboard.
 
         Args:
-            dashboard_id: Id of the dashboard to duplicate
-            display_name: Display name for the new dashboard
-            access_type: Access type for the new dashboard (PRIVATE or PUBLIC)
-            description: Description for the new dashboard
+            client: ChronicleClient instance
+            dashboard_id: ID of the dashboard to duplicate
+            display_name: New name for the duplicated dashboard
+            access_type: Access type for the duplicated dashboard
+                        (DashboardAccessType.PRIVATE or DashboardAccessType.PUBLIC)
+            description: Description for the duplicated dashboard
+            api_version: Preferred API version to use. Defaults to V1ALPHA
 
         Returns:
-            Dictionary containing the updated dashboard details
+            Dictionary containing the duplicated dashboard details
+
+        Raises:
+            APIError: If the API request fails
         """
         try:
             access_type = DashboardAccessType[access_type.upper()]
@@ -4332,18 +4381,21 @@ def duplicate_dashboard(
             display_name=display_name,
             access_type=access_type,
             description=description,
+            api_version=api_version,
         )
 
     def remove_chart(
         self,
         dashboard_id: str,
         chart_id: str,
+        api_version: APIVersion | None = APIVersion.V1ALPHA,
     ) -> dict[str, Any]:
         """Remove a chart from a dashboard.
 
         Args:
             dashboard_id: ID of the dashboard containing the chart
             chart_id: ID of the chart to remove
+            api_version: Preferred API version to use. Defaults to V1ALPHA
 
         Returns:
             Dictionary containing the updated dashboard
@@ -4355,24 +4407,34 @@ def remove_chart(
             self,
             dashboard_id=dashboard_id,
             chart_id=chart_id,
+            api_version=api_version
         )
 
-    def get_chart(self, chart_id: str) -> dict[str, Any]:
-        """Get information about a specific chart.
+    def get_chart(
+        self,
+        chart_id: str,
+        api_version: APIVersion | None = APIVersion.V1ALPHA,
+    ) -> dict[str, Any]:
+        """Get detail for dashboard chart.
 
         Args:
-            chart_id: ID of the chart to retrieve
+            chart_id: ID of the chart
+            api_version: Preferred API version to use. Defaults to V1ALPHA
 
         Returns:
-            Dictionary containing chart details
+            Dict[str, Any]: Dictionary containing chart details
+
+        Raises:
+            APIError: If the API request fails
         """
-        return _get_chart(self, chart_id)
+        return _get_chart(self, chart_id, api_version)
 
     def edit_chart(
         self,
         dashboard_id: str,
         dashboard_chart: None | (dict[str, Any] | DashboardChart | str) = None,
         dashboard_query: None | (dict[str, Any] | DashboardQuery | str) = None,
+        api_version: APIVersion | None = APIVersion.V1ALPHA,
     ) -> dict[str, Any]:
         """Edit an existing chart in a dashboard.
 
@@ -4395,15 +4457,21 @@ def edit_chart(
                     "input": {},
                     "etag":"123131231321321"
                 }
+            api_version: Preferred API version to use. Defaults to V1ALPHA
+
         Returns:
             Dictionary containing the updated dashboard with edited chart
+
+        Raises:
+            APIError: If the API request fails
         """
 
         return _edit_chart(
             self,
             dashboard_id=dashboard_id,
             dashboard_chart=dashboard_chart,
             dashboard_query=dashboard_query,
+            api_version=api_version,
         )
 
     def execute_dashboard_query(