magic_hour 0.23.0__py3-none-any.whl → 0.25.0__py3-none-any.whl

magic_hour/client.py

@@ -23,7 +23,7 @@ class Client:
             if httpx_client is None
             else httpx_client,
         )
-        self._base_client.register_auth("bearerAuth", AuthBearer(val=token))
+        self._base_client.register_auth("bearerAuth", AuthBearer(token=token))
         self.v1 = V1Client(base_client=self._base_client)
 
 
@@ -44,5 +44,5 @@ class AsyncClient:
             if httpx_client is None
             else httpx_client,
         )
-        self._base_client.register_auth("bearerAuth", AuthBearer(val=token))
+        self._base_client.register_auth("bearerAuth", AuthBearer(token=token))
         self.v1 = AsyncV1Client(base_client=self._base_client)

magic_hour/core/__init__.py

@@ -1,15 +1,13 @@
 from .api_error import ApiError
 from .auth import (
-    AuthKeyQuery,
+    AuthKey,
     AuthBasic,
     AuthBearer,
     AuthProvider,
-    AuthKeyCookie,
-    AuthKeyHeader,
     GrantType,
     OAuth2,
-    OAuth2ClientCredentialsForm,
-    OAuth2PasswordForm,
+    OAuth2ClientCredentials,
+    OAuth2Password,
 )
 from .base_client import AsyncBaseClient, BaseClient, SyncBaseClient
 from .binary_response import BinaryResponse
@@ -32,16 +30,14 @@ __all__ = [
     "RequestOptions",
     "default_request_options",
     "SyncBaseClient",
-    "AuthKeyQuery",
+    "AuthKey",
     "AuthBasic",
     "AuthBearer",
     "AuthProvider",
-    "AuthKeyCookie",
-    "AuthKeyHeader",
     "GrantType",
     "OAuth2",
-    "OAuth2ClientCredentialsForm",
-    "OAuth2PasswordForm",
+    "OAuth2ClientCredentials",
+    "OAuth2Password",
     "to_encodable",
     "to_form_urlencoded",
     "filter_not_given",

magic_hour/core/auth.py

@@ -1,14 +1,15 @@
+"""Generated by Sideko (sideko.dev)"""
+
 import abc
 import datetime
-from typing import Any, Dict, TypedDict, Optional, List, Tuple, Literal
+from typing import Any, Dict, TypedDict, Optional, List, Tuple, Literal, Union, cast
 
 import jsonpointer  # type: ignore
 import httpx
-from pydantic import BaseModel
 from .request import RequestConfig
 
 
-class AuthProvider(abc.ABC, BaseModel):
+class AuthProvider(abc.ABC):
     """
     Abstract base class defining the interface for authentication providers.
 
@@ -49,6 +50,13 @@ class AuthBasic(AuthProvider):
     username: Optional[str]
     password: Optional[str]
 
+    def __init__(
+        self, *, username: Optional[str] = None, password: Optional[str] = None
+    ):
+        super().__init__()
+        self.username = username
+        self.password = password
+
     def add_to_request(self, cfg: RequestConfig) -> RequestConfig:
         """
         Adds Basic Authentication credentials to the request configuration.
@@ -71,10 +79,14 @@ class AuthBearer(AuthProvider):
     Implements Bearer token authentication.
 
     Adds a Bearer token to the request's Authorization header following
-    the OAuth 2.0 Bearer Token scheme.
+    a 'Bearer ' prefix
     """
 
-    val: Optional[str]
+    token: Optional[str]
+
+    def __init__(self, *, token: Optional[str] = None):
+        super().__init__()
+        self.token = token
 
     def add_to_request(self, cfg: RequestConfig) -> RequestConfig:
         """
@@ -82,9 +94,9 @@ class AuthBearer(AuthProvider):
 
         Only modifies the configuration if a token value is provided.
         """
-        if self.val is not None:
+        if self.token is not None:
             headers = cfg.get("headers", dict())
-            headers["Authorization"] = f"Bearer {self.val}"
+            headers["Authorization"] = f"Bearer {self.token}"
             cfg["headers"] = headers
         return cfg
 
@@ -92,90 +104,51 @@ class AuthBearer(AuthProvider):
         """
         Sets value as the bearer token
         """
-        self.val = val
+        self.token = val
 
 
-class AuthKeyQuery(AuthProvider):
+class AuthKey(AuthProvider):
     """
-    Implements query parameter-based authentication.
+    Implements query, header, or cookie based authentication.
 
-    Adds an authentication token or key as a query parameter with a
-    configurable parameter name.
+    Adds an authentication token to the request in the configured location
     """
 
-    query_name: str
+    name: str
+    location: Literal["query", "header", "cookie"]
     val: Optional[str]
 
-    def add_to_request(self, cfg: RequestConfig) -> RequestConfig:
-        """
-        Adds authentication value as a query parameter.
-
-        Only modifies the configuration if a value is provided.
-        """
-        if self.val is not None:
-            params = cfg.get("params", dict())
-            params[self.query_name] = self.val
-            cfg["params"] = params
-        return cfg
-
-    def set_value(self, val: Optional[str]) -> None:
-        """
-        Sets value as the key
-        """
+    def __init__(
+        self,
+        *,
+        name: str,
+        location: Literal["query", "header", "cookie"],
+        val: Optional[str] = None,
+    ):
+        super().__init__()
+        self.name = name
+        self.location = location
         self.val = val
 
-
-class AuthKeyHeader(AuthProvider):
-    """
-    Implements header-based authentication.
-
-    Adds an authentication token or key as a custom header with a
-    configurable header name.
-    """
-
-    header_name: str
-    val: Optional[str]
-
     def add_to_request(self, cfg: RequestConfig) -> RequestConfig:
         """
-        Adds authentication value as a custom header.
-
-        Only modifies the configuration if a value is provided.
+        Adds authentication value as a query/header/cookie parameter
         """
-        if self.val is not None:
+        if self.val is None:
+            return cfg
+        elif self.location == "query":
+            params = cfg.get("params", dict())
+            params[self.name] = self.val
+            cfg["params"] = params
+        elif self.location == "header":
             headers = cfg.get("headers", {})
-            headers[self.header_name] = self.val
+            headers[self.name] = self.val
             cfg["headers"] = headers
-        return cfg
-
-    def set_value(self, val: Optional[str]) -> None:
-        """
-        Sets value as the key
-        """
-        self.val = val
-
-
-class AuthKeyCookie(AuthProvider):
-    """
-    Implements cookie-based authentication.
-
-    Adds an authentication token or key as a cookie with a
-    configurable cookie name.
-    """
-
-    cookie_name: str
-    val: Optional[str]
-
-    def add_to_request(self, cfg: RequestConfig) -> RequestConfig:
-        """
-        Adds authentication value as a cookie.
-
-        Only modifies the configuration if a value is provided.
-        """
-        if self.val is not None:
+        else:
             cookies = cfg.get("cookies", dict())
-            cookies[self.cookie_name] = self.val
+            cookies[self.name] = self.val
             cfg["cookies"] = cookies
+
         return cfg
 
     def set_value(self, val: Optional[str]) -> None:
@@ -185,7 +158,12 @@ class AuthKeyCookie(AuthProvider):
         self.val = val
 
 
-class OAuth2PasswordForm(TypedDict, total=True):
+GrantType = Literal["password", "client_credentials"]
+CredentialsLocation = Literal["request_body", "basic_authorization_header"]
+BodyContent = Literal["form", "json"]
+
+
+class OAuth2Password(TypedDict, total=True):
     """
     OAuth2 authentication form for a password flow
 
@@ -197,11 +175,16 @@ class OAuth2PasswordForm(TypedDict, total=True):
     password: str
     client_id: Optional[str]
     client_secret: Optional[str]
-    grant_type: Optional[str]
+    grant_type: Optional[Union[GrantType, str]]
     scope: Optional[List[str]]
 
+    token_url: Optional[str]
+    """
+    Overrides the default token url
+    """
+
 
-class OAuth2ClientCredentialsForm(TypedDict, total=True):
+class OAuth2ClientCredentials(TypedDict, total=True):
     """
     OAuth2 authentication form for a client credentials flow
 
@@ -211,13 +194,13 @@ class OAuth2ClientCredentialsForm(TypedDict, total=True):
 
     client_id: str
     client_secret: str
-    grant_type: Optional[str]
+    grant_type: Optional[Union[GrantType, str]]
     scope: Optional[List[str]]
 
-
-GrantType = Literal["password", "client_credentials"]
-CredentialsLocation = Literal["request_body", "basic_authorization_header"]
-BodyContent = Literal["form", "json"]
+    token_url: Optional[str]
+    """
+    Overrides the default token url
+    """
 
 
 class OAuth2(AuthProvider):
@@ -228,6 +211,7 @@ class OAuth2(AuthProvider):
     """
 
     # OAuth2 provider configuration
+    base_url: str
     token_url: str
     access_token_pointer: str
     expires_in_pointer: str
@@ -236,28 +220,76 @@ class OAuth2(AuthProvider):
     request_mutator: AuthProvider
 
     # OAuth2 access token request values
-    grant_type: GrantType
-    username: Optional[str] = None
-    password: Optional[str] = None
-    client_id: Optional[str] = None
-    client_secret: Optional[str] = None
-    scope: Optional[List[str]] = None
+    grant_type: Union[GrantType, str]
+    username: Optional[str]
+    password: Optional[str]
+    client_id: Optional[str]
+    client_secret: Optional[str]
+    scope: Optional[List[str]]
 
     # access_token storage
-    access_token: Optional[str] = None
-    expires_at: Optional[datetime.datetime] = None
+    access_token: Optional[str]
+    expires_at: Optional[datetime.datetime]
+
+    def __init__(
+        self,
+        *,
+        base_url: str,
+        default_token_url: str,
+        access_token_pointer: str,
+        expires_in_pointer: str,
+        credentials_location: CredentialsLocation,
+        body_content: BodyContent,
+        request_mutator: AuthProvider,
+        form: Optional[Union[OAuth2Password, OAuth2ClientCredentials]] = None,
+    ):
+        super().__init__()
+
+        form_data: Union[OAuth2Password, OAuth2ClientCredentials] = form or cast(
+            OAuth2ClientCredentials, {}
+        )
+
+        self.base_url = base_url
+        self.token_url = form_data.get("token_url") or default_token_url
+        self.access_token_pointer = access_token_pointer
+        self.expires_in_pointer = expires_in_pointer
+        self.credentials_location = credentials_location
+        self.body_content = body_content
+        self.request_mutator = request_mutator
+
+        default_grant_type: GrantType = (
+            "password"
+            if form_data.get("username") is not None
+            else "client_credentials"
+        )
+        self.grant_type = form_data.get("grant_type") or default_grant_type
+        self.username = cast(Optional[str], form_data.get("username"))
+        self.password = cast(Optional[str], form_data.get("password"))
+        self.client_id = form_data.get("client_id")
+        self.client_secret = form_data.get("client_secret")
+        self.scope = form_data.get("scope")
+
+        self.access_token = None
+        self.expires_at = None
 
     def _refresh(self) -> Tuple[str, datetime.datetime]:
-        req_cfg: Dict[str, Any] = {"url": self.token_url}
-        req_data: Dict[str, Any] = {"grant_type": self.grant_type}
+        # build token url using base_url if relative
+        url = self.token_url
+        if url.startswith("/"):
+            url = f"{self.base_url.strip('/')}/{self.token_url.strip('/')}"
+
+        req_cfg: Dict[str, Any] = {"url": url}
+        req_data: Dict[str, str] = {"grant_type": self.grant_type}
 
         # add client credentials
         if self.client_id is not None or self.client_secret is not None:
             if self.credentials_location == "basic_authorization_header":
-                req_cfg["auth"] = (self.client_id, self.client_secret)
+                req_cfg["auth"] = (self.client_id or "", self.client_secret or "")
             else:
-                req_data["client_id"] = self.client_id
-                req_data["client_secret"] = self.client_secret
+                if self.client_id is not None:
+                    req_data["client_id"] = self.client_id
+                if self.client_secret is not None:
+                    req_data["client_secret"] = self.client_secret
 
         # construct request data
         if self.username is not None:
@@ -298,10 +330,18 @@ class OAuth2(AuthProvider):
         return (access_token, expires_at)
 
     def add_to_request(self, cfg: RequestConfig) -> RequestConfig:
+        if (
+            self.username is None
+            and self.password is None
+            and self.client_id is None
+            and self.client_secret is None
+        ):
+            # provider is not configured to make an oauth token request
+            return cfg
+
         token_expired = (
             self.expires_at is not None and self.expires_at <= datetime.datetime.now()
         )
-
         if self.access_token is None or token_expired:
             access_token, expires_at = self._refresh()
             self.expires_at = expires_at

magic_hour/core/query.py

@@ -2,7 +2,6 @@ import json
 
 from typing import Any, Dict, Union
 from typing_extensions import Literal, Sequence
-from urllib.parse import quote_plus, quote
 
 import httpx
 
@@ -47,19 +46,19 @@ def _encode_form(params: QueryParams, name: str, value: Any, explode: bool):
     """
     if isinstance(value, list) and not explode:
         # non-explode form lists should be encoded like /users?id=3,4,5
-        params[name] = quote_plus(",".join(map(_query_str, value)))
+        params[name] = ",".join(map(_query_str, value))
     elif isinstance(value, dict):
         if explode:
             # explode form objects should be encoded like /users?key0=val0&key1=val1
             # the input param name will be omitted
             for k, v in value.items():
-                params[k] = quote_plus(_query_str(v))
+                params[k] = _query_str(v)
         else:
             # non-explode form objects should be encoded like /users?id=key0,val0,key1,val1
             encoded_chunks = []
             for k, v in value.items():
                 encoded_chunks.extend([str(k), _query_str(v)])
-            params[name] = quote_plus(",".join(encoded_chunks))
+            params[name] = ",".join(encoded_chunks)
     else:
         params[name] = value
 
@@ -71,7 +70,7 @@ def _encode_spaced_delimited(params: QueryParams, name: str, value: Any, explode
     """
     if isinstance(value, list) and not explode:
         # non-explode spaceDelimited lists should be encoded like /users?id=3%204%205
-        params[name] = quote(" ".join(map(_query_str, value)))
+        params[name] = " ".join(map(_query_str, value))
     else:
         # according to the docs, spaceDelimited + explode=false only effects lists,
         # all other encodings are marked as n/a or are the same as `form` style
@@ -86,7 +85,7 @@ def _encode_pipe_delimited(params: QueryParams, name: str, value: Any, explode:
     """
     if isinstance(value, list) and not explode:
         # non-explode pipeDelimited lists should be encoded like /users?id=3|4|5
-        params[name] = quote("|".join(map(_query_str, value)))
+        params[name] = "|".join(map(_query_str, value))
     else:
         # according to the docs, pipeDelimited + explode=false only effects lists,
         # all other encodings are marked as n/a or are the same as `form` style

magic_hour/environment.py

@@ -6,7 +6,7 @@ class Environment(enum.Enum):
     """Pre-defined base URLs for the API"""
 
     ENVIRONMENT = "https://api.magichour.ai"
-    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.23.0"
+    MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.25.0"
 
 
 def _get_base_url(

magic_hour/resources/v1/ai_clothes_changer/README.md

@@ -5,6 +5,13 @@ Change outfits in photos in seconds with just a photo reference. Each photo cost
 
 **API Endpoint**: `POST /v1/ai-clothes-changer`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for clothes changer | `{"garment_file_path": "api-assets/id/outfit.png", "garment_type": "dresses", "person_file_path": "api-assets/id/model.png"}` |
+| `name` | ✗ | The name of image | `"Clothes Changer image"` |
+
 #### Synchronous Client
 
 ```python
@@ -20,6 +27,7 @@ res = client.v1.ai_clothes_changer.create(
     },
     name="Clothes Changer image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -37,4 +45,13 @@ res = await client.v1.ai_clothes_changer.create(
     },
     name="Clothes Changer image",
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1AiClothesChangerCreateResponse](/magic_hour/types/models/v1_ai_clothes_changer_create_response.py)
+
+##### Example
+`{"credits_charged": 25, "frame_cost": 25, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/ai_face_editor/README.md

@@ -5,6 +5,14 @@ Edit facial features of an image using AI. Each edit costs 1 frame. The height/w
 
 **API Endpoint**: `POST /v1/ai-face-editor`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for face editor | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `style` | ✓ | Face editing parameters | `{"enhance_face": False, "eye_gaze_horizontal": 0.0, "eye_gaze_vertical": 0.0, "eye_open_ratio": 0.0, "eyebrow_direction": 0.0, "head_pitch": 0.0, "head_roll": 0.0, "head_yaw": 0.0, "lip_open_ratio": 0.0, "mouth_grim": 0.0, "mouth_position_horizontal": 0.0, "mouth_position_vertical": 0.0, "mouth_pout": 0.0, "mouth_purse": 0.0, "mouth_smile": 0.0}` |
+| `name` | ✗ | The name of image | `"Face Editor image"` |
+
 #### Synchronous Client
 
 ```python
@@ -33,6 +41,7 @@ res = client.v1.ai_face_editor.create(
     },
     name="Face Editor image",
 )
+
 ```
 
 #### Asynchronous Client
@@ -63,4 +72,13 @@ res = await client.v1.ai_face_editor.create(
     },
     name="Face Editor image",
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1AiFaceEditorCreateResponse](/magic_hour/types/models/v1_ai_face_editor_create_response.py)
+
+##### Example
+`{"credits_charged": 1, "frame_cost": 1, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/ai_gif_generator/README.md

@@ -5,6 +5,13 @@ Create an AI GIF. Each GIF costs 25 credits.
 
 **API Endpoint**: `POST /v1/ai-gif-generator`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `style` | ✓ |  | `{"prompt": "Cute dancing cat, pixel art"}` |
+| `name` | ✗ | The name of gif | `"Ai Gif gif"` |
+
 #### Synchronous Client
 
 ```python
@@ -15,6 +22,7 @@ client = Client(token=getenv("API_TOKEN"))
 res = client.v1.ai_gif_generator.create(
     style={"prompt": "Cute dancing cat, pixel art"}, name="Ai Gif gif"
 )
+
 ```
 
 #### Asynchronous Client
@@ -27,4 +35,13 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.ai_gif_generator.create(
     style={"prompt": "Cute dancing cat, pixel art"}, name="Ai Gif gif"
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1AiGifGeneratorCreateResponse](/magic_hour/types/models/v1_ai_gif_generator_create_response.py)
+
+##### Example
+`{"credits_charged": 25, "frame_cost": 25, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/ai_headshot_generator/README.md

@@ -5,6 +5,14 @@ Create an AI headshot. Each headshot costs 50 credits.
 
 **API Endpoint**: `POST /v1/ai-headshot-generator`
 
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for headshot photo | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `name` | ✗ | The name of image | `"Ai Headshot image"` |
+| `style` | ✗ |  | `{"prompt": "professional passport photo, business attire, smiling, good posture, light blue background, centered, plain background"}` |
+
 #### Synchronous Client
 
 ```python
@@ -15,6 +23,7 @@ client = Client(token=getenv("API_TOKEN"))
 res = client.v1.ai_headshot_generator.create(
     assets={"image_file_path": "api-assets/id/1234.png"}, name="Ai Headshot image"
 )
+
 ```
 
 #### Asynchronous Client
@@ -27,4 +36,13 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.ai_headshot_generator.create(
     assets={"image_file_path": "api-assets/id/1234.png"}, name="Ai Headshot image"
 )
+
 ```
+
+#### Response
+
+##### Type
+[V1AiHeadshotGeneratorCreateResponse](/magic_hour/types/models/v1_ai_headshot_generator_create_response.py)
+
+##### Example
+`{"credits_charged": 50, "frame_cost": 50, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/ai_image_editor/README.md

@@ -0,0 +1,52 @@
+
+### AI Image Editor <a name="create"></a>
+
+Edit images with AI. Each edit costs 50 credits.
+
+**API Endpoint**: `POST /v1/ai-image-editor`
+
+#### Parameters
+
+| Parameter | Required | Description | Example |
+|-----------|:--------:|-------------|--------|
+| `assets` | ✓ | Provide the assets for image edit | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `style` | ✓ |  | `{"prompt": "Give me sunglasses"}` |
+| `name` | ✗ | The name of image | `"Ai Image Editor image"` |
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.ai_image_editor.create(
+    assets={"image_file_path": "api-assets/id/1234.png"},
+    style={"prompt": "Give me sunglasses"},
+    name="Ai Image Editor image",
+)
+
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.ai_image_editor.create(
+    assets={"image_file_path": "api-assets/id/1234.png"},
+    style={"prompt": "Give me sunglasses"},
+    name="Ai Image Editor image",
+)
+
+```
+
+#### Response
+
+##### Type
+[V1AiImageEditorCreateResponse](/magic_hour/types/models/v1_ai_image_editor_create_response.py)
+
+##### Example
+`{"credits_charged": 50, "frame_cost": 50, "id": "clx7uu86w0a5qp55yxz315r6r"}`

magic_hour/resources/v1/ai_image_editor/__init__.py

@@ -0,0 +1,4 @@
+from .client import AiImageEditorClient, AsyncAiImageEditorClient
+
+
+__all__ = ["AiImageEditorClient", "AsyncAiImageEditorClient"]