feat: add support for slides export

JIRA: F1-1268
risk: low

Author: hkad98

gooddata-sdk/gooddata_sdk/__init__.py

@@ -66,6 +66,7 @@
     ExportCustomOverride,
     ExportRequest,
     ExportSettings,
+    SlidesExportRequest,
     VisualExportRequest,
 )
 from gooddata_sdk.catalog.filter_by import CatalogFilterBy

gooddata-sdk/gooddata_sdk/catalog/export/request.py

@@ -1,11 +1,12 @@
 # (C) 2023 GoodData Corporation
-from typing import Optional
+from typing import Literal, Optional
 
 from attrs import define
 from gooddata_api_client.model.custom_label import CustomLabel as ApiCustomLabel
 from gooddata_api_client.model.custom_metric import CustomMetric as ApiCustomMetric
 from gooddata_api_client.model.custom_override import CustomOverride as ApiCustomOverride
 from gooddata_api_client.model.settings import Settings as ApiSettings
+from gooddata_api_client.model.slides_export_request import SlidesExportRequest as SlidesExportRequestApi
 from gooddata_api_client.model.tabular_export_request import TabularExportRequest
 from gooddata_api_client.model.visual_export_request import VisualExportRequest as VisualExportRequestApi
 
@@ -121,3 +122,31 @@ def client_class() -> type[VisualExportRequestApi]:
             type[TabularExportRequest]: VisualExportRequest class
         """
         return VisualExportRequestApi
+
+
+@define(auto_attribs=True, kw_only=True)
+class SlidesExportRequest(Base):
+    """
+    SlidesExportRequest class is used to create a slide export request in the desired format, filename, and settings.
+    Attributes:
+        dashboard_id (str): Dashboard identifier.
+        file_name (str): File name to be used for retrieving the PDF document.
+        metadata (Optional[Dict[str, bool]]): Optional dictionary containing settings for the export request.
+    """
+
+    file_name: str
+    format: Literal["PDF", "PPTX"]
+    dashboard_id: Optional[str] = None
+    widget_ids: Optional[list[str]] = None
+    visualization_ids: Optional[list[str]] = None
+    metadata: Optional[dict] = None
+    templateId: Optional[str] = None
+
+    @staticmethod
+    def client_class() -> type[SlidesExportRequestApi]:
+        """
+        Returns the appropriate client class for the visual export request.
+        Returns:
+            type[SlidesExportRequestApi]: SlidesExportRequestApi class
+        """
+        return SlidesExportRequestApi

gooddata-sdk/gooddata_sdk/catalog/export/service.py

@@ -4,13 +4,15 @@
 from typing import Any, Callable, Optional, Union
 
 from gooddata_api_client.exceptions import NotFoundException
+from gooddata_api_client.model.slides_export_request import SlidesExportRequest as SlidesExportRequestApi
 from gooddata_api_client.model.tabular_export_request import TabularExportRequest
 from gooddata_api_client.model.visual_export_request import VisualExportRequest
 
 from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase
 from gooddata_sdk.catalog.export.request import (
     ExportRequest,
     ExportSettings,
+    SlidesExportRequest,
 )
 from gooddata_sdk.client import GoodDataApiClient
 from gooddata_sdk.visualization import VisualizationService
@@ -140,7 +142,7 @@ def _dashboard_id_exists(self, workspace_id: str, dashboard_id: str) -> bool:
     def _export_common(
         self,
         workspace_id: str,
-        request: Union[VisualExportRequest, TabularExportRequest],
+        request: Union[VisualExportRequest, TabularExportRequest, SlidesExportRequestApi],
         file_path: Path,
         create_func: Callable,
         get_func: Callable,
@@ -314,3 +316,33 @@ def export_tabular_by_visualization_id(
             retry=retry,
             max_retry=max_retry,
         )
+
+    def export_slides(
+        self,
+        workspace_id: str,
+        request: SlidesExportRequest,
+        store_path: Union[str, Path] = Path.cwd(),
+        timeout: float = 60.0,
+        retry: float = 0.2,
+        max_retry: float = 5.0,
+    ) -> None:
+        """
+        Exports slides based on slide export request.
+
+        Args:
+            workspace_id (str): The workspace id from which the visualization is to be exported.
+            request (SlidesExportRequest): The request object containing the export parameters.
+            store_path (Union[str, Path], optional): The path to store the exported file. Default to Path.cwd().
+            timeout (float, optional): The maximum time to wait for the export to finish. Defaults to 60.0.
+            retry (float, optional):
+                Initial wait time (in seconds) before retrying to get the exported content. Defaults to 0.2.
+            max_retry (float, optional): The maximum retry wait time (in seconds). Defaults to 5.0.
+
+        Returns:
+            None
+        """
+        store_path = store_path if isinstance(store_path, Path) else Path(store_path)
+        file_path = store_path / f"{request.file_name}.{request.format.lower()}"
+        create_func = self._actions_api.create_slides_export
+        get_func = self._actions_api.get_slides_export
+        self._export_common(workspace_id, request.to_api(), file_path, create_func, get_func, timeout, retry, max_retry)