magic_hour 0.41.0__py3-none-any.whl → 0.42.0__py3-none-any.whl

magic_hour/helpers/download.py

@@ -23,6 +23,7 @@ def download_files_sync(
     downloads: Union[
         List[models.V1ImageProjectsGetResponseDownloadsItem],
         List[models.V1VideoProjectsGetResponseDownloadsItem],
+        List[models.V1AudioProjectsGetResponseDownloadsItem],
     ],
     download_directory: Union[str, None] = None,
 ) -> List[str]:
@@ -51,6 +52,7 @@ async def download_files_async(
     downloads: Union[
         List[models.V1ImageProjectsGetResponseDownloadsItem],
         List[models.V1VideoProjectsGetResponseDownloadsItem],
+        List[models.V1AudioProjectsGetResponseDownloadsItem],
     ],
     download_directory: Union[str, None] = None,
 ) -> List[str]:

magic_hour/resources/v1/ai_voice_generator/README.md

@@ -2,6 +2,62 @@
 
 ## Module Functions
 
+<!-- CUSTOM DOCS START -->
+
+### Ai Talking Photo Generate Workflow <a name="generate"></a>
+
+The workflow performs the following action
+
+1. upload local assets to Magic Hour storage. So you can pass in a local path instead of having to upload files yourself
+2. trigger a generation
+3. poll for a completion status. This is configurable
+4. if success, download the output to local directory
+
+> [!TIP]
+> This is the recommended way to use the SDK unless you have specific needs where it is necessary to split up the actions.
+
+#### Parameters
+
+In Additional to the parameters listed in the `.create` section below, `.generate` introduces 3 new parameters:
+
+- `wait_for_completion` (bool, default True): Whether to wait for the project to complete.
+- `download_outputs` (bool, default True): Whether to download the generated files
+- `download_directory` (str, optional): Directory to save downloaded files (defaults to current directory)
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.ai_talking_photo.generate(
+    style={"prompt": "Hello, how are you?", "voice_name": "Elon Musk"},
+    name="Voice Generator audio",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.ai_talking_photo.generate(
+    style={"prompt": "Hello, how are you?", "voice_name": "Elon Musk"},
+    name="Voice Generator audio",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+<!-- CUSTOM DOCS END -->
+
 ### AI Voice Generator <a name="create"></a>
 
 Generate speech from text. Each character costs 0.05 credits. The cost is rounded up to the nearest whole number.

magic_hour/resources/v1/ai_voice_generator/client.py

@@ -1,5 +1,10 @@
 import typing
 
+from magic_hour.helpers.logger import get_sdk_logger
+from magic_hour.resources.v1.audio_projects.client import (
+    AsyncAudioProjectsClient,
+    AudioProjectsClient,
+)
 from magic_hour.types import models, params
 from make_api_request import (
     AsyncBaseClient,
@@ -11,10 +16,70 @@ from make_api_request import (
 )
 
 
+logger = get_sdk_logger(__name__)
+
+
 class AiVoiceGeneratorClient:
     def __init__(self, *, base_client: SyncBaseClient):
         self._base_client = base_client
 
+    def generate(
+        self,
+        *,
+        style: params.V1AiVoiceGeneratorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate AI voice (alias for create with additional functionality).
+
+        Generate speech from text. Each character costs 0.05 credits. The cost is rounded up to the nearest whole number.
+
+        Args:
+            style: The content used to generate speech.
+            name: The name of audio. This value is mainly used for your own identification of the audio.
+            wait_for_completion: Whether to wait for the audio project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1AudioProjectsGetResponseWithDownloads: The response from the AI Voice Generator API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = client.v1.ai_voice_generator.generate(
+            style={"prompt": "Hello, how are you?", "voice_name": "Elon Musk"},
+            name="Generated Voice",
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        create_response = self.create(
+            style=style,
+            name=name,
+            request_options=request_options,
+        )
+        logger.info(f"AI Voice Generator response: {create_response}")
+
+        audio_projects_client = AudioProjectsClient(base_client=self._base_client)
+        response = audio_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
     def create(
         self,
         *,
@@ -69,6 +134,63 @@ class AsyncAiVoiceGeneratorClient:
     def __init__(self, *, base_client: AsyncBaseClient):
         self._base_client = base_client
 
+    async def generate(
+        self,
+        *,
+        style: params.V1AiVoiceGeneratorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate AI voice (alias for create with additional functionality).
+
+        Generate speech from text. Each character costs 0.05 credits. The cost is rounded up to the nearest whole number.
+
+        Args:
+            style: The content used to generate speech.
+            name: The name of audio. This value is mainly used for your own identification of the audio.
+            wait_for_completion: Whether to wait for the audio project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1AudioProjectsGetResponseWithDownloads: The response from the AI Voice Generator API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = await client.v1.ai_voice_generator.generate(
+            style={"prompt": "Hello, how are you?", "voice_name": "Elon Musk"},
+            name="Generated Voice",
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        create_response = await self.create(
+            style=style,
+            name=name,
+            request_options=request_options,
+        )
+        logger.info(f"AI Voice Generator response: {create_response}")
+
+        audio_projects_client = AsyncAudioProjectsClient(base_client=self._base_client)
+        response = await audio_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
     async def create(
         self,
         *,

magic_hour/resources/v1/audio_projects/README.md

@@ -2,6 +2,53 @@
 
 ## Module Functions
 
+<!-- CUSTOM DOCS START -->
+
+### Check results <a name="check-result"></a>
+
+Poll the details API to check on the status of the rendering. Optionally can also download the output
+
+#### Parameters
+
+| Parameter             | Required | Description                                                                                          | Example          |
+| --------------------- | :------: | ---------------------------------------------------------------------------------------------------- | ---------------- |
+| `id`                  |    ✓     | Unique ID of the audio project. This value is returned by all of the POST APIs that create an audio. | `"cuid-example"` |
+| `wait_for_completion` |    ✗     | Whether to wait for the project to complete.                                                         | `True`           |
+| `download_outputs`    |    ✗     | Whether to download the generated files                                                              | `True`           |
+| `download_directory`  |    ✗     | Directory to save downloaded files (defaults to current directory)                                   | `"./outputs"`    |
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.audio_projects.check_result(
+  id="cuid-example",
+  wait_for_completion=True,
+  download_outputs=True,
+  download_directory="outputs",
+)
+
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.audio_projects.check_result(
+  id="cuid-example",
+  wait_for_completion=True,
+  download_outputs=True,
+  download_directory="outputs",
+)
+```
+
+<!-- CUSTOM DOCS END -->
 ### Delete audio <a name="delete"></a>
 
 Permanently delete the rendered audio file(s). This action is not reversible, please be sure before deleting.

magic_hour/resources/v1/audio_projects/__init__.py

@@ -1,4 +1,12 @@
-from .client import AsyncAudioProjectsClient, AudioProjectsClient
+from .client import (
+    AsyncAudioProjectsClient,
+    AudioProjectsClient,
+    V1AudioProjectsGetResponseWithDownloads,
+)
 
 
-__all__ = ["AsyncAudioProjectsClient", "AudioProjectsClient"]
+__all__ = [
+    "AsyncAudioProjectsClient",
+    "AudioProjectsClient",
+    "V1AudioProjectsGetResponseWithDownloads",
+]

magic_hour/resources/v1/audio_projects/client.py

@@ -1,5 +1,10 @@
+import os
+import pydantic
+import time
 import typing
 
+from magic_hour.helpers.download import download_files_async, download_files_sync
+from magic_hour.helpers.logger import get_sdk_logger
 from magic_hour.types import models
 from make_api_request import (
     AsyncBaseClient,
@@ -9,10 +14,83 @@ from make_api_request import (
 )
 
 
+logger = get_sdk_logger(__name__)
+
+
+class V1AudioProjectsGetResponseWithDownloads(models.V1AudioProjectsGetResponse):
+    downloaded_paths: typing.Optional[typing.List[str]] = pydantic.Field(
+        default=None, alias="downloaded_paths"
+    )
+    """
+    The paths to the downloaded files.
+
+    This field is only populated if `download_outputs` is True and the audio project is complete.
+    """
+
+
 class AudioProjectsClient:
     def __init__(self, *, base_client: SyncBaseClient):
         self._base_client = base_client
 
+    def check_result(
+        self,
+        id: str,
+        wait_for_completion: bool,
+        download_outputs: bool,
+        download_directory: typing.Optional[str] = None,
+    ) -> V1AudioProjectsGetResponseWithDownloads:
+        """
+        Check the result of an audio project with optional waiting and downloading.
+
+        This method retrieves the status of an audio project and optionally waits for completion
+        and downloads the output files.
+
+        Args:
+            id: Unique ID of the audio project
+            wait_for_completion: Whether to wait for the audio project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided,
+                the outputs will be downloaded to the current working directory
+
+        Returns:
+            V1AudioProjectsGetResponseWithDownloads: The audio project response with optional
+                downloaded file paths included
+        """
+        api_response = self.get(id=id)
+        if not wait_for_completion:
+            response = V1AudioProjectsGetResponseWithDownloads(
+                **api_response.model_dump()
+            )
+            return response
+
+        poll_interval = float(os.getenv("MAGIC_HOUR_POLL_INTERVAL", "0.5"))
+
+        status = api_response.status
+
+        while status not in ["complete", "error", "canceled"]:
+            api_response = self.get(id=id)
+            status = api_response.status
+            time.sleep(poll_interval)
+
+        if api_response.status != "complete":
+            log = logger.error if api_response.status == "error" else logger.info
+            log(
+                f"Audio project {id} has status {api_response.status}: {api_response.error}"
+            )
+            return V1AudioProjectsGetResponseWithDownloads(**api_response.model_dump())
+
+        if not download_outputs:
+            return V1AudioProjectsGetResponseWithDownloads(**api_response.model_dump())
+
+        downloaded_paths = download_files_sync(
+            downloads=api_response.downloads,
+            download_directory=download_directory,
+        )
+
+        return V1AudioProjectsGetResponseWithDownloads(
+            **api_response.model_dump(), downloaded_paths=downloaded_paths
+        )
+
     def delete(
         self, *, id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> None:
@@ -95,6 +173,65 @@ class AsyncAudioProjectsClient:
     def __init__(self, *, base_client: AsyncBaseClient):
         self._base_client = base_client
 
+    async def check_result(
+        self,
+        id: str,
+        wait_for_completion: bool,
+        download_outputs: bool,
+        download_directory: typing.Optional[str] = None,
+    ) -> V1AudioProjectsGetResponseWithDownloads:
+        """
+        Check the result of an audio project with optional waiting and downloading.
+
+        This method retrieves the status of an audio project and optionally waits for completion
+        and downloads the output files.
+
+        Args:
+            id: Unique ID of the audio project
+            wait_for_completion: Whether to wait for the audio project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided,
+                the outputs will be downloaded to the current working directory
+
+        Returns:
+            V1AudioProjectsGetResponseWithDownloads: The audio project response with optional
+                downloaded file paths included
+        """
+        api_response = await self.get(id=id)
+        if not wait_for_completion:
+            response = V1AudioProjectsGetResponseWithDownloads(
+                **api_response.model_dump()
+            )
+            return response
+
+        poll_interval = float(os.getenv("MAGIC_HOUR_POLL_INTERVAL", "0.5"))
+
+        status = api_response.status
+
+        while status not in ["complete", "error", "canceled"]:
+            api_response = await self.get(id=id)
+            status = api_response.status
+            time.sleep(poll_interval)
+
+        if api_response.status != "complete":
+            log = logger.error if api_response.status == "error" else logger.info
+            log(
+                f"Audio project {id} has status {api_response.status}: {api_response.error}"
+            )
+            return V1AudioProjectsGetResponseWithDownloads(**api_response.model_dump())
+
+        if not download_outputs:
+            return V1AudioProjectsGetResponseWithDownloads(**api_response.model_dump())
+
+        downloaded_paths = await download_files_async(
+            downloads=api_response.downloads,
+            download_directory=download_directory,
+        )
+
+        return V1AudioProjectsGetResponseWithDownloads(
+            **api_response.model_dump(), downloaded_paths=downloaded_paths
+        )
+
     async def delete(
         self, *, id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> None:

magic_hour/resources/v1/audio_projects/client_test.py

@@ -0,0 +1,520 @@
+import datetime
+import pytest
+import httpx
+from pathlib import Path
+from typing import Any, Generator, Literal, Union, List
+from unittest.mock import Mock, AsyncMock
+
+from magic_hour.types import models
+from magic_hour.resources.v1.audio_projects.client import (
+    AudioProjectsClient,
+    AsyncAudioProjectsClient,
+)
+
+
+class DummyResponse(models.V1AudioProjectsGetResponse):
+    """Helper response with defaults"""
+
+    def __init__(
+        self,
+        *,
+        status: Literal[
+            "complete", "queued", "rendering", "error", "canceled"
+        ] = "complete",
+        download_url: Union[str, None] = None,
+        error: Union[str, None] = None,
+    ):
+        # Create error object if error string is provided
+        error_obj = None
+        if error:
+            error_obj = models.V1AudioProjectsGetResponseError(
+                code="TEST_ERROR", message=error
+            )
+
+        super().__init__(
+            id="test-id",
+            created_at=datetime.datetime.now().isoformat(),
+            credits_charged=0,
+            downloads=[
+                models.V1AudioProjectsGetResponseDownloadsItem(
+                    url=download_url, expires_at="2024-01-01T00:00:00Z"
+                )
+            ]
+            if download_url
+            else [],
+            enabled=True,
+            error=error_obj,
+            name="test-name",
+            status=status,
+            type="test-type",
+        )
+
+
+@pytest.fixture
+def mock_base_client() -> Generator[Mock, None, None]:
+    yield Mock()
+
+
+@pytest.fixture
+def mock_async_base_client() -> Generator[AsyncMock, None, None]:
+    yield AsyncMock()
+
+
+def test_delete_calls_base_client(mock_base_client: Mock) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+    client.delete(id="123")
+
+    mock_base_client.request.assert_called_once()
+    call = mock_base_client.request.call_args[1]
+    assert call["method"] == "DELETE"
+    assert "/v1/audio-projects/123" in call["path"]
+
+
+def test_get_calls_base_client(mock_base_client: Mock) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+    mock_base_client.request.return_value = DummyResponse()
+
+    resp = client.get(id="abc")
+
+    mock_base_client.request.assert_called_once()
+    assert isinstance(resp, models.V1AudioProjectsGetResponse)
+    assert resp.id == "test-id"
+
+
+def test_check_result_no_wait_no_download(mock_base_client: Mock) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+    mock_base_client.request.return_value = DummyResponse(status="queued")
+
+    resp = client.check_result(
+        id="xyz",
+        wait_for_completion=False,
+        download_outputs=False,
+    )
+
+    assert resp.downloaded_paths is None
+
+
+def test_check_result_wait_until_complete(
+    monkeypatch: Any, mock_base_client: Mock
+) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+
+    # First calls return queued, then complete
+    mock_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    monkeypatch.setattr("time.sleep", lambda _: None)  # type: ignore
+
+    resp = client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    assert resp.downloaded_paths is None
+
+
+def test_check_result_download_outputs(
+    tmp_path: Path, mock_base_client: Mock, monkeypatch: Any
+) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+
+    file_url = "https://example.com/file.mp3"
+    mock_base_client.request.return_value = DummyResponse(
+        status="complete",
+        download_url=file_url,
+    )
+
+    # Create a mock response for httpx
+    mock_request = httpx.Request("GET", "https://example.com/file.mp3")
+    mock_response = httpx.Response(200, content=b"fake mp3", request=mock_request)
+
+    # Mock the httpx.Client class
+    class MockClient:
+        def __init__(self):
+            pass
+
+        def __enter__(self) -> "MockClient":
+            return self
+
+        def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+            pass
+
+        def get(self, url: str) -> httpx.Response:
+            return mock_response
+
+    monkeypatch.setattr(httpx, "Client", MockClient)
+
+    resp = client.check_result(
+        id="xyz",
+        wait_for_completion=True,
+        download_outputs=True,
+        download_directory=str(tmp_path),
+    )
+
+    assert resp.status == "complete"
+    assert resp.downloaded_paths
+    saved_file = Path(resp.downloaded_paths[0])
+    assert saved_file.exists()
+    assert saved_file.read_bytes() == b"fake mp3"
+
+
+def test_check_result_error_status(mock_base_client: Mock) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+    mock_base_client.request.return_value = DummyResponse(status="error", error="Boom!")
+
+    resp = client.check_result(
+        id="err", wait_for_completion=True, download_outputs=False
+    )
+    assert resp.status == "error"
+    assert resp.error is not None
+    assert resp.error.message == "Boom!"
+    assert resp.downloaded_paths is None
+
+
+def test_check_result_canceled_status(mock_base_client: Mock) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+    mock_base_client.request.return_value = DummyResponse(status="canceled")
+
+    resp = client.check_result(
+        id="cancel", wait_for_completion=True, download_outputs=False
+    )
+    assert resp.status == "canceled"
+    assert resp.downloaded_paths is None
+
+
+def test_check_result_poll_interval_default(
+    mock_base_client: Mock, monkeypatch: Any
+) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+
+    # First calls return queued, then complete
+    mock_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    # Mock time.sleep to track calls
+    sleep_calls: List[float] = []
+
+    def mock_sleep(seconds: float) -> None:
+        sleep_calls.append(seconds)
+
+    monkeypatch.setattr("time.sleep", mock_sleep)
+
+    resp = client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    # Should have slept once with default interval (0.5)
+    assert len(sleep_calls) == 1
+    assert sleep_calls[0] == 0.5
+
+
+def test_check_result_poll_interval_custom(
+    mock_base_client: Mock, monkeypatch: Any
+) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+
+    # Set custom poll interval
+    monkeypatch.setenv("MAGIC_HOUR_POLL_INTERVAL", "1.0")
+
+    # First calls return queued, then complete
+    mock_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    # Mock time.sleep to track calls
+    sleep_calls: List[float] = []
+
+    def mock_sleep(seconds: float) -> None:
+        sleep_calls.append(seconds)
+
+    monkeypatch.setattr("time.sleep", mock_sleep)
+
+    resp = client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    # Should have slept once with custom interval (1.0)
+    assert len(sleep_calls) == 1
+    assert sleep_calls[0] == 1.0
+
+
+def test_check_result_poll_interval_multiple_polls(
+    mock_base_client: Mock, monkeypatch: Any
+) -> None:
+    client = AudioProjectsClient(base_client=mock_base_client)
+
+    # Set custom poll interval
+    monkeypatch.setenv("MAGIC_HOUR_POLL_INTERVAL", "0.1")
+
+    # Multiple calls return queued before complete
+    mock_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="queued"),
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    # Mock time.sleep to track calls
+    sleep_calls: List[float] = []
+
+    def mock_sleep(seconds: float) -> None:
+        sleep_calls.append(seconds)
+
+    monkeypatch.setattr("time.sleep", mock_sleep)
+
+    resp = client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    # Should have slept 3 times with custom interval (0.1)
+    assert len(sleep_calls) == 3
+    assert all(sleep_time == 0.1 for sleep_time in sleep_calls)
+
+
+@pytest.mark.asyncio
+async def test_async_delete_calls_base_client(
+    mock_async_base_client: AsyncMock,
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+    await client.delete(id="456")
+
+    mock_async_base_client.request.assert_called_once()
+    call = mock_async_base_client.request.call_args[1]
+    assert call["method"] == "DELETE"
+    assert "/v1/audio-projects/456" in call["path"]
+
+
+@pytest.mark.asyncio
+async def test_async_get_calls_base_client(mock_async_base_client: AsyncMock) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+    mock_async_base_client.request.return_value = DummyResponse()
+
+    resp = await client.get(id="zzz")
+
+    mock_async_base_client.request.assert_called_once()
+    assert isinstance(resp, models.V1AudioProjectsGetResponse)
+    assert resp.id == "test-id"
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_no_wait_no_download(
+    mock_async_base_client: AsyncMock,
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+    mock_async_base_client.request.return_value = DummyResponse(status="queued")
+
+    resp = await client.check_result(
+        id="xyz",
+        wait_for_completion=False,
+        download_outputs=False,
+    )
+
+    assert resp.downloaded_paths is None
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_wait_until_complete(
+    mock_async_base_client: AsyncMock, monkeypatch: Any
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+
+    # First calls return queued, then complete
+    mock_async_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    monkeypatch.setattr("time.sleep", lambda _: None)  # type: ignore
+
+    resp = await client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    assert resp.downloaded_paths is None
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_download_outputs(
+    tmp_path: Path, mock_async_base_client: AsyncMock, monkeypatch: Any
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+
+    file_url = "https://example.com/file.mp3"
+    mock_async_base_client.request.return_value = DummyResponse(
+        status="complete",
+        download_url=file_url,
+    )
+
+    # Create a mock response for httpx
+    mock_request = httpx.Request("GET", "https://example.com/file.mp3")
+    mock_response = httpx.Response(200, content=b"fake mp3", request=mock_request)
+
+    # Mock the httpx.AsyncClient class
+    class MockAsyncClient:
+        def __init__(self):
+            pass
+
+        async def __aenter__(self) -> "MockAsyncClient":
+            return self
+
+        async def __aexit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+            pass
+
+        async def get(self, url: str) -> httpx.Response:
+            return mock_response
+
+    monkeypatch.setattr(httpx, "AsyncClient", MockAsyncClient)
+
+    resp = await client.check_result(
+        id="xyz",
+        wait_for_completion=True,
+        download_outputs=True,
+        download_directory=str(tmp_path),
+    )
+
+    assert resp.status == "complete"
+    assert resp.downloaded_paths
+    saved_file = Path(resp.downloaded_paths[0])
+    assert saved_file.exists()
+    assert saved_file.read_bytes() == b"fake mp3"
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_error_status(
+    mock_async_base_client: AsyncMock,
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+    mock_async_base_client.request.return_value = DummyResponse(
+        status="error", error="Boom!"
+    )
+
+    resp = await client.check_result(
+        id="err", wait_for_completion=True, download_outputs=False
+    )
+    assert resp.status == "error"
+    assert resp.error is not None
+    assert resp.error.message == "Boom!"
+    assert resp.downloaded_paths is None
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_canceled_status(
+    mock_async_base_client: AsyncMock,
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+    mock_async_base_client.request.return_value = DummyResponse(status="canceled")
+
+    resp = await client.check_result(
+        id="cancel", wait_for_completion=True, download_outputs=False
+    )
+    assert resp.status == "canceled"
+    assert resp.downloaded_paths is None
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_poll_interval_default(
+    mock_async_base_client: AsyncMock, monkeypatch: Any
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+
+    # First calls return queued, then complete
+    mock_async_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    # Mock time.sleep to track calls
+    sleep_calls: List[float] = []
+
+    def mock_sleep(seconds: float) -> None:
+        sleep_calls.append(seconds)
+
+    monkeypatch.setattr("time.sleep", mock_sleep)
+
+    resp = await client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    # Should have slept once with default interval (0.5)
+    assert len(sleep_calls) == 1
+    assert sleep_calls[0] == 0.5
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_poll_interval_custom(
+    mock_async_base_client: AsyncMock, monkeypatch: Any
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+
+    # Set custom poll interval
+    monkeypatch.setenv("MAGIC_HOUR_POLL_INTERVAL", "2.0")
+
+    # First calls return queued, then complete
+    mock_async_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    # Mock time.sleep to track calls
+    sleep_calls: List[float] = []
+
+    def mock_sleep(seconds: float) -> None:
+        sleep_calls.append(seconds)
+
+    monkeypatch.setattr("time.sleep", mock_sleep)
+
+    resp = await client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    # Should have slept once with custom interval (2.0)
+    assert len(sleep_calls) == 1
+    assert sleep_calls[0] == 2.0
+
+
+@pytest.mark.asyncio
+async def test_async_check_result_poll_interval_multiple_polls(
+    mock_async_base_client: AsyncMock, monkeypatch: Any
+) -> None:
+    client = AsyncAudioProjectsClient(base_client=mock_async_base_client)
+
+    # Set custom poll interval
+    monkeypatch.setenv("MAGIC_HOUR_POLL_INTERVAL", "0.3")
+
+    # Multiple calls return queued before complete
+    mock_async_base_client.request.side_effect = [
+        DummyResponse(status="queued"),
+        DummyResponse(status="queued"),
+        DummyResponse(status="queued"),
+        DummyResponse(status="complete"),
+    ]
+
+    # Mock time.sleep to track calls
+    sleep_calls: List[float] = []
+
+    def mock_sleep(seconds: float) -> None:
+        sleep_calls.append(seconds)
+
+    monkeypatch.setattr("time.sleep", mock_sleep)
+
+    resp = await client.check_result(
+        id="xyz", wait_for_completion=True, download_outputs=False
+    )
+
+    assert resp.status == "complete"
+    # Should have slept 3 times with custom interval (0.3)
+    assert len(sleep_calls) == 3
+    assert all(sleep_time == 0.3 for sleep_time in sleep_calls)

magic_hour/resources/v1/lip_sync/README.md

@@ -40,6 +40,9 @@ res = client.v1.lip_sync.generate(
         "video_file_path": "/path/to/1234.mp4",
         "video_source": "file",
     },
+    style={
+        "generation_mode": "lite",
+    },
     end_seconds=15.0,
     start_seconds=0.0,
     max_fps_limit=12.0,
@@ -63,6 +66,9 @@ res = await client.v1.lip_sync.generate(
         "video_file_path": "/path/to/1234.mp4",
         "video_source": "file",
     },
+    style={
+        "generation_mode": "lite",
+    },
     end_seconds=15.0,
     start_seconds=0.0,
     max_fps_limit=12.0,
@@ -114,6 +120,9 @@ res = client.v1.lip_sync.create(
         "video_file_path": "api-assets/id/1234.mp4",
         "video_source": "file",
     },
+    style={
+        "generation_mode": "lite",
+    },
     end_seconds=15.0,
     start_seconds=0.0,
     max_fps_limit=12.0,
@@ -135,6 +144,9 @@ res = await client.v1.lip_sync.create(
         "video_file_path": "api-assets/id/1234.mp4",
         "video_source": "file",
     },
+    style={
+        "generation_mode": "lite",
+    },
     end_seconds=15.0,
     start_seconds=0.0,
     max_fps_limit=12.0,

magic_hour/resources/v1/lip_sync/client.py

@@ -39,6 +39,9 @@ class LipSyncClient:
         name: typing.Union[
             typing.Optional[str], type_utils.NotGiven
         ] = type_utils.NOT_GIVEN,
+        style: typing.Union[
+            typing.Optional[params.V1LipSyncCreateBodyStyle], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
         width: typing.Union[
             typing.Optional[int], type_utils.NotGiven
         ] = type_utils.NOT_GIVEN,
@@ -56,6 +59,7 @@ class LipSyncClient:
             height: `height` is deprecated and no longer influences the output video's resolution.
             max_fps_limit: Defines the maximum FPS (frames per second) for the output video. If the input video's FPS is lower than this limit, the output video will retain the input FPS. This is useful for reducing unnecessary frame usage in scenarios where high FPS is not required.
             name: The name of video. This value is mainly used for your own identification of the video.
+            style: Attributes used to dictate the style of the output
             width: `width` is deprecated and no longer influences the output video's resolution.
             assets: Provide the assets for lip-sync. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
             end_seconds: The end time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.1, and more than the start_seconds.
@@ -108,6 +112,7 @@ class LipSyncClient:
             height=height,
             max_fps_limit=max_fps_limit,
             name=name,
+            style=style,
             width=width,
             request_options=request_options,
         )

{magic_hour-0.41.0.dist-info → magic_hour-0.42.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: magic_hour
-Version: 0.41.0
+Version: 0.42.0
 Summary: Python SDK for Magic Hour API
 Requires-Python: >=3.8,<4.0
 Classifier: Programming Language :: Python :: 3
@@ -226,6 +226,7 @@ download_urls = result.downloads
 ### [v1.ai_voice_generator](magic_hour/resources/v1/ai_voice_generator/README.md)
 
 * [create](magic_hour/resources/v1/ai_voice_generator/README.md#create) - AI Voice Generator
+* [generate](magic_hour/resources/v1/ai_voice_generator/README.md#generate) - Ai Voice Generator Generate Workflow
 
 ### [v1.animation](magic_hour/resources/v1/animation/README.md)
 
@@ -234,6 +235,7 @@ download_urls = result.downloads
 
 ### [v1.audio_projects](magic_hour/resources/v1/audio_projects/README.md)
 
+* [check-result](magic_hour/resources/v1/audio_projects/README.md#check-result) - Check results
 * [delete](magic_hour/resources/v1/audio_projects/README.md#delete) - Delete audio
 * [get](magic_hour/resources/v1/audio_projects/README.md#get) - Get audio details
 

{magic_hour-0.41.0.dist-info → magic_hour-0.42.0.dist-info}/RECORD

@@ -3,7 +3,7 @@ magic_hour/__init__.py,sha256=ypWA4msPy3T-U2PAyRSAXIQc0m2J9aY8wXnfmIupAEc,214
 magic_hour/client.py,sha256=oHuz0FRKuedtwwPSkFLaSjoEWt_0N57hJ0rEDKbNcFw,1712
 magic_hour/environment.py,sha256=tAHxEiK1_4L0_MZntbQuQA1Np-kDHZ8M6QbpON1uwsY,535
 magic_hour/helpers/__init__.py,sha256=pO6sgb41iVe_IN2dApfl2l3BXOWIb4i5pHl_if-oo_E,176
-magic_hour/helpers/download.py,sha256=wZR-gddqU2rWzltHN2zqqaHaShHG33yx7BIlUn1jXG8,2212
+magic_hour/helpers/download.py,sha256=_aZmpr9tzqzeyPbvc1Xz95GJhEgOqH1-GHh66Ild57E,2336
 magic_hour/helpers/logger.py,sha256=Z8ljney670Kc8DaSzlHdH9N8RXmj2_qWPovLUoC0tNY,210
 magic_hour/resources/v1/README.md,sha256=P5Y3atMFloJotSgJWt5Wtz2z9YnV3B5bcWBu-vppzP8,1793
 magic_hour/resources/v1/__init__.py,sha256=Aj0sjVcoijjQyieNBxv2_uewPYC2vO2UG-ehoBgCz5E,86
@@ -40,15 +40,16 @@ magic_hour/resources/v1/ai_qr_code_generator/client.py,sha256=rLw0V6cE2AncqM9Bz_
 magic_hour/resources/v1/ai_talking_photo/README.md,sha256=M33SsFSeGhOVlDKy14qR7ClUD-6qrrMghnwOxgq7vBU,5609
 magic_hour/resources/v1/ai_talking_photo/__init__.py,sha256=ZTDD_IRBoR7GSdGWCVEK2-LOEsKUdGEHZZvDHa9MOnA,134
 magic_hour/resources/v1/ai_talking_photo/client.py,sha256=kbFM3peM5NEzUle1miup7Xe2q_HwL7u7kzuD1DkcEBc,12529
-magic_hour/resources/v1/ai_voice_generator/README.md,sha256=A8K356cP6Q2Q83OP--qdjpTmCo_TcehvHUBQEkPChXE,1837
+magic_hour/resources/v1/ai_voice_generator/README.md,sha256=gfGlxiXD04a8HutUjMb1GVoEs0D6kxnMNjSJny5y9Zo,3569
 magic_hour/resources/v1/ai_voice_generator/__init__.py,sha256=Zl1HuxfafN3hzJCCCD_YyCX_y2v4uAihSDAC8GCcE8U,142
-magic_hour/resources/v1/ai_voice_generator/client.py,sha256=6XV4PRkRZqqLe3q8OVNO-tGEpsR59QsaNTMlQE3yGGQ,3922
+magic_hour/resources/v1/ai_voice_generator/client.py,sha256=VhrGUhdznSDSBgzLNa7pjqjWC7-cXzYVUyjyGf4c7xo,8749
 magic_hour/resources/v1/animation/README.md,sha256=ZRyrlI2qh2aYJ-sHF7_8vFMLcQlmDcQEsu78LGVu958,7602
 magic_hour/resources/v1/animation/__init__.py,sha256=M6KUe6TEZl_DAdyn1HFQ2kHYanZo6xy3mvUdCN264hQ,114
 magic_hour/resources/v1/animation/client.py,sha256=vVoYF6P-OU83kAXwZyRJngv6C_zoArXXuM6nTPy-Jvw,15447
-magic_hour/resources/v1/audio_projects/README.md,sha256=8OXRVddZNw27p9OyHyq-2OEgDdiUZ7gTGILIlrs7QSA,2596
-magic_hour/resources/v1/audio_projects/__init__.py,sha256=zPN8qohWZr3d1TXpCLQHfj7jK8blNDOEx7_9K63MG68,130
-magic_hour/resources/v1/audio_projects/client.py,sha256=yeOk77fv9YXnk6h1kZJFZE0cMYqsw462IWq8YwcNR7w,5784
+magic_hour/resources/v1/audio_projects/README.md,sha256=pRoIuJvk5BcgdQq4WVQt98WQ0dk8FYFvkLKE-Jue1SM,4375
+magic_hour/resources/v1/audio_projects/__init__.py,sha256=QG5bxr8z40p54-38pawFobEowm_nrx5IURMU4hjrCtI,246
+magic_hour/resources/v1/audio_projects/client.py,sha256=9AIDLuAU6TswVWS7BAnmL2F-PbVz-UcCwy1OjLnOfas,10979
+magic_hour/resources/v1/audio_projects/client_test.py,sha256=n1nMtZgc9TTBKGiiVcMciX3jXHtMs5cAPRrD6s9e6L8,15776
 magic_hour/resources/v1/auto_subtitle_generator/README.md,sha256=IGi0wXf4T_iBI6fFXVr7enTDKYNCwN3HorDOjQuRyJA,5309
 magic_hour/resources/v1/auto_subtitle_generator/__init__.py,sha256=dnWFEiSdIl3AwFVprqWHSMzqpeHgZz9wPEMxm7c3Xnc,162
 magic_hour/resources/v1/auto_subtitle_generator/client.py,sha256=QZREuGcgIVc3hNaBvTfDuBRj0pvnr_uu0YzFkFhsd_s,14803
@@ -79,9 +80,9 @@ magic_hour/resources/v1/image_projects/client_test.py,sha256=5KH4s0vG13SEUkB6pAa
 magic_hour/resources/v1/image_to_video/README.md,sha256=3_wM8ZtJfZrWMLQnq092v2uIycFvIIjm8tPz7T0A3OY,6273
 magic_hour/resources/v1/image_to_video/__init__.py,sha256=tY_ABo6evwKQBRSq-M84lNX-pXqmxoozukmrO6NhCgA,126
 magic_hour/resources/v1/image_to_video/client.py,sha256=fUajB5-kKzT3WC5u7EAeY8_N4k1_r36JmwML4GquQwc,17392
-magic_hour/resources/v1/lip_sync/README.md,sha256=2qkWaodE4Au4Z1CU11r7TxxuZdbU1tpeKUr066msmx8,7389
+magic_hour/resources/v1/lip_sync/README.md,sha256=4KSIj9aOz3vgwdMkpe-X6l86j9BvYPl-RhAS51u4bsU,7605
 magic_hour/resources/v1/lip_sync/__init__.py,sha256=MlKUAoHNSKcuNzVyqNfLnLtD_PsqEn3l1TtVpPC1JqQ,106
-magic_hour/resources/v1/lip_sync/client.py,sha256=NbyMKOZ0mUTNODxnWjaBU6y3zRPf772s4rzGnpC1jKE,19529
+magic_hour/resources/v1/lip_sync/client.py,sha256=hFnNps9HSEG6Zi3x56PP5WorbFzm7NnicRiLfR2kZ8o,19769
 magic_hour/resources/v1/photo_colorizer/README.md,sha256=wql3I3PNIwMZkiCWaQCbMujrtIHW1y4vJ5ce5HX7q0k,3430
 magic_hour/resources/v1/photo_colorizer/__init__.py,sha256=7rDjkeUzWG5GXw_4RD1XH7Ygy-_0_OUFX99IgE_RVbE,134
 magic_hour/resources/v1/photo_colorizer/client.py,sha256=mW5VYDmsvU9phtkiY008zarM1CCaWTMTeOTY4zaWDfI,8861
@@ -216,7 +217,7 @@ magic_hour/types/params/v1_video_to_video_create_body.py,sha256=BV52jJcXnOsKaw-M
 magic_hour/types/params/v1_video_to_video_create_body_assets.py,sha256=XwdoqT1x5ElcWb6qUfmtabNsyaatEsOygB4gJ154y-M,1660
 magic_hour/types/params/v1_video_to_video_create_body_style.py,sha256=cYiwKRRSJpwHwL_00wxXcXHvym8q1VsT2VBFOPfJNQM,6000
 magic_hour/types/params/v1_video_to_video_generate_body_assets.py,sha256=j06Y1RKZKwEXW9Zdfhr3Lntx7eDAKpH-k1N1XkKuqPM,915
-magic_hour-0.41.0.dist-info/LICENSE,sha256=F3fxj7JXPgB2K0uj8YXRsVss4u-Dgt_-U3V4VXsivNI,1070
-magic_hour-0.41.0.dist-info/METADATA,sha256=jGmEEuPpFVOnSSQWc1bGfavWmJ-zc_5tcla3U5rX1Ho,12978
-magic_hour-0.41.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-magic_hour-0.41.0.dist-info/RECORD,,
+magic_hour-0.42.0.dist-info/LICENSE,sha256=F3fxj7JXPgB2K0uj8YXRsVss4u-Dgt_-U3V4VXsivNI,1070
+magic_hour-0.42.0.dist-info/METADATA,sha256=Tr3fizT_MQzlJf0YRwTsIc69GnsZt1fRhUPmbp9Vaxo,13189
+magic_hour-0.42.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+magic_hour-0.42.0.dist-info/RECORD,,