magic_hour 0.9.5__py3-none-any.whl → 0.44.0__py3-none-any.whl

magic_hour/types/params/v1_ai_image_editor_generate_body_assets.py

@@ -0,0 +1,28 @@
+import pydantic
+import typing_extensions
+
+
+class V1AiImageEditorGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for image edit
+    """
+
+    image_file_path: typing_extensions.NotRequired[str]
+    """
+    Deprecated: Please use `image_file_paths` instead as edits with multiple images are now supported.
+
+    The image used in the edit. This value is either
+    - a direct URL to the image file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """
+
+    image_file_paths: typing_extensions.NotRequired[typing_extensions.List[str]]
+    """
+    The image(s) used in the edit, maximum of 10 images. This value is either
+    - a direct URL to the video file
+    - a path to a local file
+    
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """

magic_hour/types/params/{post_v1_ai_image_generator_body.py → v1_ai_image_generator_create_body.py}

@@ -2,37 +2,43 @@ import pydantic
 import typing
 import typing_extensions
 
-from .post_v1_ai_image_generator_body_style import (
-    PostV1AiImageGeneratorBodyStyle,
-    _SerializerPostV1AiImageGeneratorBodyStyle,
+from .v1_ai_image_generator_create_body_style import (
+    V1AiImageGeneratorCreateBodyStyle,
+    _SerializerV1AiImageGeneratorCreateBodyStyle,
 )
 
 
-class PostV1AiImageGeneratorBody(typing_extensions.TypedDict):
+class V1AiImageGeneratorCreateBody(typing_extensions.TypedDict):
     """
-    PostV1AiImageGeneratorBody
+    V1AiImageGeneratorCreateBody
     """
 
     image_count: typing_extensions.Required[int]
     """
-    number to images to generate
+    Number of images to generate.
     """
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of image
+    The name of image. This value is mainly used for your own identification of the image.
     """
 
     orientation: typing_extensions.Required[
         typing_extensions.Literal["landscape", "portrait", "square"]
     ]
+    """
+    The orientation of the output image(s).
+    """
 
-    style: typing_extensions.Required[PostV1AiImageGeneratorBodyStyle]
+    style: typing_extensions.Required[V1AiImageGeneratorCreateBodyStyle]
+    """
+    The art style to use for image generation.
+    """
 
 
-class _SerializerPostV1AiImageGeneratorBody(pydantic.BaseModel):
+class _SerializerV1AiImageGeneratorCreateBody(pydantic.BaseModel):
     """
-    Serializer for PostV1AiImageGeneratorBody handling case conversions
+    Serializer for V1AiImageGeneratorCreateBody handling case conversions
     and file omissions as dictated by the API
     """
 
@@ -49,6 +55,6 @@ class _SerializerPostV1AiImageGeneratorBody(pydantic.BaseModel):
             alias="orientation",
         )
     )
-    style: _SerializerPostV1AiImageGeneratorBodyStyle = pydantic.Field(
+    style: _SerializerV1AiImageGeneratorCreateBodyStyle = pydantic.Field(
         alias="style",
     )

magic_hour/types/params/v1_ai_image_generator_create_body_style.py

@@ -0,0 +1,127 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1AiImageGeneratorCreateBodyStyle(typing_extensions.TypedDict):
+    """
+    The art style to use for image generation.
+    """
+
+    prompt: typing_extensions.Required[str]
+    """
+    The prompt used for the image(s).
+    """
+
+    quality_mode: typing_extensions.NotRequired[
+        typing_extensions.Literal["pro", "standard"]
+    ]
+    """
+    Controls the quality of the generated image. Defaults to 'standard' if not specified.
+    
+    **Options:**
+    - `standard` - Standard quality generation. Cost: 5 credits per image.
+    - `pro` - Pro quality generation with enhanced details and quality. Cost: 30 credits per image.
+    
+    Note: Pro mode is available for users on Creator, Pro, or Business tier.
+    """
+
+    tool: typing_extensions.NotRequired[
+        typing_extensions.Literal[
+            "ai-anime-generator",
+            "ai-art-generator",
+            "ai-background-generator",
+            "ai-character-generator",
+            "ai-face-generator",
+            "ai-fashion-generator",
+            "ai-icon-generator",
+            "ai-illustration-generator",
+            "ai-interior-design-generator",
+            "ai-landscape-generator",
+            "ai-logo-generator",
+            "ai-manga-generator",
+            "ai-outfit-generator",
+            "ai-pattern-generator",
+            "ai-photo-generator",
+            "ai-sketch-generator",
+            "ai-tattoo-generator",
+            "album-cover-generator",
+            "animated-characters-generator",
+            "architecture-generator",
+            "book-cover-generator",
+            "comic-book-generator",
+            "dark-fantasy-ai",
+            "disney-ai-generator",
+            "dnd-ai-art-generator",
+            "emoji-generator",
+            "fantasy-map-generator",
+            "general",
+            "graffiti-generator",
+            "movie-poster-generator",
+            "optical-illusion-generator",
+            "pokemon-generator",
+            "south-park-character-generator",
+            "superhero-generator",
+            "thumbnail-maker",
+        ]
+    ]
+    """
+    The art style to use for image generation. Defaults to 'general' if not provided.
+    """
+
+
+class _SerializerV1AiImageGeneratorCreateBodyStyle(pydantic.BaseModel):
+    """
+    Serializer for V1AiImageGeneratorCreateBodyStyle handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    prompt: str = pydantic.Field(
+        alias="prompt",
+    )
+    quality_mode: typing.Optional[typing_extensions.Literal["pro", "standard"]] = (
+        pydantic.Field(alias="quality_mode", default=None)
+    )
+    tool: typing.Optional[
+        typing_extensions.Literal[
+            "ai-anime-generator",
+            "ai-art-generator",
+            "ai-background-generator",
+            "ai-character-generator",
+            "ai-face-generator",
+            "ai-fashion-generator",
+            "ai-icon-generator",
+            "ai-illustration-generator",
+            "ai-interior-design-generator",
+            "ai-landscape-generator",
+            "ai-logo-generator",
+            "ai-manga-generator",
+            "ai-outfit-generator",
+            "ai-pattern-generator",
+            "ai-photo-generator",
+            "ai-sketch-generator",
+            "ai-tattoo-generator",
+            "album-cover-generator",
+            "animated-characters-generator",
+            "architecture-generator",
+            "book-cover-generator",
+            "comic-book-generator",
+            "dark-fantasy-ai",
+            "disney-ai-generator",
+            "dnd-ai-art-generator",
+            "emoji-generator",
+            "fantasy-map-generator",
+            "general",
+            "graffiti-generator",
+            "movie-poster-generator",
+            "optical-illusion-generator",
+            "pokemon-generator",
+            "south-park-character-generator",
+            "superhero-generator",
+            "thumbnail-maker",
+        ]
+    ] = pydantic.Field(alias="tool", default=None)

magic_hour/types/params/v1_ai_image_upscaler_create_body.py

@@ -0,0 +1,59 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_ai_image_upscaler_create_body_assets import (
+    V1AiImageUpscalerCreateBodyAssets,
+    _SerializerV1AiImageUpscalerCreateBodyAssets,
+)
+from .v1_ai_image_upscaler_create_body_style import (
+    V1AiImageUpscalerCreateBodyStyle,
+    _SerializerV1AiImageUpscalerCreateBodyStyle,
+)
+
+
+class V1AiImageUpscalerCreateBody(typing_extensions.TypedDict):
+    """
+    V1AiImageUpscalerCreateBody
+    """
+
+    assets: typing_extensions.Required[V1AiImageUpscalerCreateBodyAssets]
+    """
+    Provide the assets for upscaling
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of image. This value is mainly used for your own identification of the image.
+    """
+
+    scale_factor: typing_extensions.Required[float]
+    """
+    How much to scale the image. Must be either 2 or 4.
+                
+    Note: 4x upscale is only available on Creator, Pro, or Business tier.
+    """
+
+    style: typing_extensions.Required[V1AiImageUpscalerCreateBodyStyle]
+
+
+class _SerializerV1AiImageUpscalerCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1AiImageUpscalerCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1AiImageUpscalerCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    scale_factor: float = pydantic.Field(
+        alias="scale_factor",
+    )
+    style: _SerializerV1AiImageUpscalerCreateBodyStyle = pydantic.Field(
+        alias="style",
+    )

magic_hour/types/params/v1_ai_image_upscaler_create_body_assets.py

@@ -0,0 +1,33 @@
+import pydantic
+import typing_extensions
+
+
+class V1AiImageUpscalerCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for upscaling
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image to upscale. This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+
+class _SerializerV1AiImageUpscalerCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1AiImageUpscalerCreateBodyAssets handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    image_file_path: str = pydantic.Field(
+        alias="image_file_path",
+    )

magic_hour/types/params/{post_v1_ai_image_upscaler_body_style.py → v1_ai_image_upscaler_create_body_style.py}

@@ -3,9 +3,9 @@ import typing
 import typing_extensions
 
 
-class PostV1AiImageUpscalerBodyStyle(typing_extensions.TypedDict):
+class V1AiImageUpscalerCreateBodyStyle(typing_extensions.TypedDict):
     """
-    PostV1AiImageUpscalerBodyStyle
+    V1AiImageUpscalerCreateBodyStyle
     """
 
     enhancement: typing_extensions.Required[
@@ -18,9 +18,9 @@ class PostV1AiImageUpscalerBodyStyle(typing_extensions.TypedDict):
     """
 
 
-class _SerializerPostV1AiImageUpscalerBodyStyle(pydantic.BaseModel):
+class _SerializerV1AiImageUpscalerCreateBodyStyle(pydantic.BaseModel):
     """
-    Serializer for PostV1AiImageUpscalerBodyStyle handling case conversions
+    Serializer for V1AiImageUpscalerCreateBodyStyle handling case conversions
     and file omissions as dictated by the API
     """
 

magic_hour/types/params/v1_ai_image_upscaler_generate_body_assets.py

@@ -0,0 +1,17 @@
+import pydantic
+import typing_extensions
+
+
+class V1AiImageUpscalerGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for upscaling
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image to upscale. This value is either
+    - a direct URL to the image file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """

magic_hour/types/params/v1_ai_meme_generator_create_body.py

@@ -0,0 +1,37 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_ai_meme_generator_create_body_style import (
+    V1AiMemeGeneratorCreateBodyStyle,
+    _SerializerV1AiMemeGeneratorCreateBodyStyle,
+)
+
+
+class V1AiMemeGeneratorCreateBody(typing_extensions.TypedDict):
+    """
+    V1AiMemeGeneratorCreateBody
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of the meme.
+    """
+
+    style: typing_extensions.Required[V1AiMemeGeneratorCreateBodyStyle]
+
+
+class _SerializerV1AiMemeGeneratorCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1AiMemeGeneratorCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    style: _SerializerV1AiMemeGeneratorCreateBodyStyle = pydantic.Field(
+        alias="style",
+    )

magic_hour/types/params/v1_ai_meme_generator_create_body_style.py

@@ -0,0 +1,73 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1AiMemeGeneratorCreateBodyStyle(typing_extensions.TypedDict):
+    """
+    V1AiMemeGeneratorCreateBodyStyle
+    """
+
+    search_web: typing_extensions.NotRequired[bool]
+    """
+    Whether to search the web for meme content.
+    """
+
+    template: typing_extensions.Required[
+        typing_extensions.Literal[
+            "Bike Fall",
+            "Change My Mind",
+            "Disappointed Guy",
+            "Drake Hotline Bling",
+            "Galaxy Brain",
+            "Gru's Plan",
+            "Is This a Pigeon",
+            "Panik Kalm Panik",
+            "Random",
+            "Side Eyeing Chloe",
+            "Tuxedo Winnie The Pooh",
+            "Two Buttons",
+            "Waiting Skeleton",
+        ]
+    ]
+    """
+    To use our templates, pass in one of the enum values.
+    """
+
+    topic: typing_extensions.Required[str]
+    """
+    The topic of the meme.
+    """
+
+
+class _SerializerV1AiMemeGeneratorCreateBodyStyle(pydantic.BaseModel):
+    """
+    Serializer for V1AiMemeGeneratorCreateBodyStyle handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    search_web: typing.Optional[bool] = pydantic.Field(alias="searchWeb", default=None)
+    template: typing_extensions.Literal[
+        "Bike Fall",
+        "Change My Mind",
+        "Disappointed Guy",
+        "Drake Hotline Bling",
+        "Galaxy Brain",
+        "Gru's Plan",
+        "Is This a Pigeon",
+        "Panik Kalm Panik",
+        "Random",
+        "Side Eyeing Chloe",
+        "Tuxedo Winnie The Pooh",
+        "Two Buttons",
+        "Waiting Skeleton",
+    ] = pydantic.Field(
+        alias="template",
+    )
+    topic: str = pydantic.Field(
+        alias="topic",
+    )

magic_hour/types/params/{post_v1_ai_photo_editor_body.py → v1_ai_photo_editor_create_body.py}

@@ -2,29 +2,29 @@ import pydantic
 import typing
 import typing_extensions
 
-from .post_v1_ai_photo_editor_body_assets import (
-    PostV1AiPhotoEditorBodyAssets,
-    _SerializerPostV1AiPhotoEditorBodyAssets,
+from .v1_ai_photo_editor_create_body_assets import (
+    V1AiPhotoEditorCreateBodyAssets,
+    _SerializerV1AiPhotoEditorCreateBodyAssets,
 )
-from .post_v1_ai_photo_editor_body_style import (
-    PostV1AiPhotoEditorBodyStyle,
-    _SerializerPostV1AiPhotoEditorBodyStyle,
+from .v1_ai_photo_editor_create_body_style import (
+    V1AiPhotoEditorCreateBodyStyle,
+    _SerializerV1AiPhotoEditorCreateBodyStyle,
 )
 
 
-class PostV1AiPhotoEditorBody(typing_extensions.TypedDict):
+class V1AiPhotoEditorCreateBody(typing_extensions.TypedDict):
     """
-    PostV1AiPhotoEditorBody
+    V1AiPhotoEditorCreateBody
     """
 
-    assets: typing_extensions.Required[PostV1AiPhotoEditorBodyAssets]
+    assets: typing_extensions.Required[V1AiPhotoEditorCreateBodyAssets]
     """
     Provide the assets for photo editor
     """
 
     name: typing_extensions.NotRequired[str]
     """
-    The name of image
+    The name of image. This value is mainly used for your own identification of the image.
     """
 
     resolution: typing_extensions.Required[int]
@@ -37,12 +37,12 @@ class PostV1AiPhotoEditorBody(typing_extensions.TypedDict):
     Deprecated: Please use `.style.steps` instead. Number of iterations used to generate the output. Higher values improve quality and increase the strength of the prompt but increase processing time.
     """
 
-    style: typing_extensions.Required[PostV1AiPhotoEditorBodyStyle]
+    style: typing_extensions.Required[V1AiPhotoEditorCreateBodyStyle]
 
 
-class _SerializerPostV1AiPhotoEditorBody(pydantic.BaseModel):
+class _SerializerV1AiPhotoEditorCreateBody(pydantic.BaseModel):
     """
-    Serializer for PostV1AiPhotoEditorBody handling case conversions
+    Serializer for V1AiPhotoEditorCreateBody handling case conversions
     and file omissions as dictated by the API
     """
 
@@ -50,7 +50,7 @@ class _SerializerPostV1AiPhotoEditorBody(pydantic.BaseModel):
         populate_by_name=True,
     )
 
-    assets: _SerializerPostV1AiPhotoEditorBodyAssets = pydantic.Field(
+    assets: _SerializerV1AiPhotoEditorCreateBodyAssets = pydantic.Field(
         alias="assets",
     )
     name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
@@ -58,6 +58,6 @@ class _SerializerPostV1AiPhotoEditorBody(pydantic.BaseModel):
         alias="resolution",
     )
     steps: typing.Optional[int] = pydantic.Field(alias="steps", default=None)
-    style: _SerializerPostV1AiPhotoEditorBodyStyle = pydantic.Field(
+    style: _SerializerV1AiPhotoEditorCreateBodyStyle = pydantic.Field(
         alias="style",
     )

magic_hour/types/params/v1_ai_photo_editor_create_body_assets.py

@@ -0,0 +1,33 @@
+import pydantic
+import typing_extensions
+
+
+class V1AiPhotoEditorCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for photo editor
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image used to generate the output. This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+
+class _SerializerV1AiPhotoEditorCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1AiPhotoEditorCreateBodyAssets handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    image_file_path: str = pydantic.Field(
+        alias="image_file_path",
+    )

magic_hour/types/params/{post_v1_ai_photo_editor_body_style.py → v1_ai_photo_editor_create_body_style.py}

@@ -3,9 +3,9 @@ import typing
 import typing_extensions
 
 
-class PostV1AiPhotoEditorBodyStyle(typing_extensions.TypedDict):
+class V1AiPhotoEditorCreateBodyStyle(typing_extensions.TypedDict):
     """
-    PostV1AiPhotoEditorBodyStyle
+    V1AiPhotoEditorCreateBodyStyle
     """
 
     image_description: typing_extensions.Required[str]
@@ -38,10 +38,20 @@ class PostV1AiPhotoEditorBodyStyle(typing_extensions.TypedDict):
     Number of iterations used to generate the output. Higher values improve quality and increase the strength of the prompt but increase processing time.
     """
 
+    upscale_factor: typing_extensions.NotRequired[int]
+    """
+    The multiplier applied to an image's original dimensions during the upscaling process. For example, a scale of 2 doubles the width and height (e.g., from 512x512 to 1024x1024).
+    """
+
+    upscale_fidelity: typing_extensions.NotRequired[float]
+    """
+    Upscale fidelity refers to the level of quality desired in the generated image. Fidelity value of 1 means more details.
+    """
+
 
-class _SerializerPostV1AiPhotoEditorBodyStyle(pydantic.BaseModel):
+class _SerializerV1AiPhotoEditorCreateBodyStyle(pydantic.BaseModel):
     """
-    Serializer for PostV1AiPhotoEditorBodyStyle handling case conversions
+    Serializer for V1AiPhotoEditorCreateBodyStyle handling case conversions
     and file omissions as dictated by the API
     """
 
@@ -65,3 +75,9 @@ class _SerializerPostV1AiPhotoEditorBodyStyle(pydantic.BaseModel):
         alias="prompt_strength",
     )
     steps: typing.Optional[int] = pydantic.Field(alias="steps", default=None)
+    upscale_factor: typing.Optional[int] = pydantic.Field(
+        alias="upscale_factor", default=None
+    )
+    upscale_fidelity: typing.Optional[float] = pydantic.Field(
+        alias="upscale_fidelity", default=None
+    )

magic_hour/types/params/v1_ai_photo_editor_generate_body_assets.py

@@ -0,0 +1,17 @@
+import pydantic
+import typing_extensions
+
+
+class V1AiPhotoEditorGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for photo editor
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image used to generate the output. This value is either
+    - a direct URL to the image file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """

magic_hour/types/params/v1_ai_qr_code_generator_create_body.py

@@ -0,0 +1,45 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_ai_qr_code_generator_create_body_style import (
+    V1AiQrCodeGeneratorCreateBodyStyle,
+    _SerializerV1AiQrCodeGeneratorCreateBodyStyle,
+)
+
+
+class V1AiQrCodeGeneratorCreateBody(typing_extensions.TypedDict):
+    """
+    V1AiQrCodeGeneratorCreateBody
+    """
+
+    content: typing_extensions.Required[str]
+    """
+    The content of the QR code.
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of image. This value is mainly used for your own identification of the image.
+    """
+
+    style: typing_extensions.Required[V1AiQrCodeGeneratorCreateBodyStyle]
+
+
+class _SerializerV1AiQrCodeGeneratorCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1AiQrCodeGeneratorCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    content: str = pydantic.Field(
+        alias="content",
+    )
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    style: _SerializerV1AiQrCodeGeneratorCreateBodyStyle = pydantic.Field(
+        alias="style",
+    )