Add overloads and return_id option to create_dataset

Enhanced the create_dataset fixture with type overloads and a return_id parameter to optionally return both persistentId and id. Updated type hints for improved clarity and flexibility in test usage.

Author: JR-1991

tests/conftest.py

@@ -1,7 +1,9 @@
 import os
-import pytest
-import httpx
 import random
+from typing import Literal, Tuple, Union, overload
+
+import httpx
+import pytest
 
 
 @pytest.fixture
@@ -16,11 +18,30 @@ def credentials():
     return BASE_URL, API_TOKEN
 
 
+@overload
 def create_dataset(
     parent: str,
     server_url: str,
     api_token: str,
-):
+    return_id: Literal[False] = False,
+) -> str: ...
+
+
+@overload
+def create_dataset(
+    parent: str,
+    server_url: str,
+    api_token: str,
+    return_id: Literal[True],
+) -> Tuple[str, int]: ...
+
+
+def create_dataset(
+    parent: str,
+    server_url: str,
+    api_token: str,
+    return_id: bool = False,
+) -> Union[str, Tuple[str, int]]:
     """
     Creates a dataset in a Dataverse.
 
@@ -30,7 +51,7 @@ def create_dataset(
         api_token (str): The API token for authentication.
 
     Returns:
-        str: The persistent identifier of the created dataset.
+        Dict: The response from the Dataverse API.
     """
     if server_url.endswith("/"):
         server_url = server_url[:-1]
@@ -39,12 +60,15 @@ def create_dataset(
     response = httpx.post(
         url=url,
         headers={"X-Dataverse-key": api_token},
-        data=open("./tests/fixtures/create_dataset.json", "rb"),
+        data=open("./tests/fixtures/create_dataset.json", "rb"),  # type: ignore
     )
 
     response.raise_for_status()
 
-    return response.json()["data"]["persistentId"]
+    if return_id:
+        return response.json()["data"]["persistentId"], response.json()["data"]["id"]
+    else:
+        return response.json()["data"]["persistentId"]
 
 
 def create_mock_file(