deprecate create_recording

Author: czerwiukk

fishjam/api/_fishjam_client.py

@@ -5,6 +5,7 @@
 from io import BytesIO
 from pathlib import Path
 from typing import Any, Literal, cast
+from warnings import deprecated
 
 from fishjam._fishjam_openapi_client.api.credentials import (
     validate_credentials as credentials_validate_credentials,
@@ -546,6 +547,7 @@ def create_moq_access(
 
         return response
 
+    @deprecated("Use `create_composition_recording` instead.")
     def create_recording(
         self,
         source: CompositionSource,
@@ -573,6 +575,33 @@ def create_recording(
 
         return resp.data
 
+    def create_composition_recording(
+        self,
+        source: CompositionSource,
+        metadata: dict[str, Any] | None = None,
+    ) -> Recording:
+        """Creates a new recording.
+
+        Capturing starts synchronously, so the returned recording is `active`.
+
+        Args:
+            source: The source of the recording.
+            metadata: Free-form metadata used to organize and filter recordings.
+
+        Returns:
+            Recording: The started recording details.
+        """
+        config = RecordingConfig(
+            source=source, metadata=self.__parse_recording_metadata(metadata)
+        )
+
+        resp = cast(
+            RecordingDetailsResponse,
+            self._request(recording_create_recording, body=config),
+        )
+
+        return resp.data
+
     def create_template_recording(
         self,
         source: TemplateSource,