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

magic_hour/types/models/v1_audio_projects_get_response.py

@@ -0,0 +1,72 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_audio_projects_get_response_downloads_item import (
+    V1AudioProjectsGetResponseDownloadsItem,
+)
+from .v1_audio_projects_get_response_error import V1AudioProjectsGetResponseError
+
+
+class V1AudioProjectsGetResponse(pydantic.BaseModel):
+    """
+    Success
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    created_at: str = pydantic.Field(
+        alias="created_at",
+    )
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the audio. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the audio, credits will be refunded and this field will be updated to include the refund.
+    """
+    downloads: typing.List[V1AudioProjectsGetResponseDownloadsItem] = pydantic.Field(
+        alias="downloads",
+    )
+    enabled: bool = pydantic.Field(
+        alias="enabled",
+    )
+    """
+    Indicates whether the resource is deleted
+    """
+    error: typing.Optional[V1AudioProjectsGetResponseError] = pydantic.Field(
+        alias="error",
+    )
+    """
+    In the case of an error, this object will contain the error encountered during video render
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    Unique ID of the audio. This value can be used in the [get audio project API](https://docs.magichour.ai/api-reference/audio-projects/get-audio-details) to fetch additional details such as status
+    """
+    name: typing.Optional[str] = pydantic.Field(
+        alias="name",
+    )
+    """
+    The name of the audio.
+    """
+    status: typing_extensions.Literal[
+        "canceled", "complete", "draft", "error", "queued", "rendering"
+    ] = pydantic.Field(
+        alias="status",
+    )
+    """
+    The status of the audio.
+    """
+    type_: str = pydantic.Field(
+        alias="type",
+    )
+    """
+    The type of the audio project. Possible values are VOICE_GENERATOR, VOICE_CHANGER, VOICE_CLONER
+    """

magic_hour/types/models/v1_audio_projects_get_response_downloads_item.py

@@ -0,0 +1,19 @@
+import pydantic
+
+
+class V1AudioProjectsGetResponseDownloadsItem(pydantic.BaseModel):
+    """
+    The download url and expiration date of the audio project
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    expires_at: str = pydantic.Field(
+        alias="expires_at",
+    )
+    url: str = pydantic.Field(
+        alias="url",
+    )

magic_hour/types/models/{get_v1_image_projects_id_response_error.py → v1_audio_projects_get_response_error.py}

@@ -1,7 +1,7 @@
 import pydantic
 
 
-class GetV1ImageProjectsIdResponseError(pydantic.BaseModel):
+class V1AudioProjectsGetResponseError(pydantic.BaseModel):
     """
     In the case of an error, this object will contain the error encountered during video render
     """
@@ -11,7 +11,7 @@ class GetV1ImageProjectsIdResponseError(pydantic.BaseModel):
         populate_by_name=True,
     )
 
-    code_field: str = pydantic.Field(
+    code: str = pydantic.Field(
         alias="code",
     )
     """

magic_hour/types/models/v1_auto_subtitle_generator_create_response.py

@@ -0,0 +1,35 @@
+import pydantic
+
+
+class V1AutoSubtitleGeneratorCreateResponse(pydantic.BaseModel):
+    """
+    Success
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the video. If the status is not 'complete', this value is an estimate and may be adjusted upon completion based on the actual FPS of the output video. 
+    
+    If video generation fails, credits will be refunded, and this field will be updated to include the refund.
+    """
+    estimated_frame_cost: int = pydantic.Field(
+        alias="estimated_frame_cost",
+    )
+    """
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for video generation. Use 'credits_charged' instead.
+    
+    The amount of frames used to generate the video. If the status is not 'complete', the cost is an estimate and will be adjusted when the video completes.
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    Unique ID of the video. This value can be used in the [get video project API](https://docs.magichour.ai/api-reference/video-projects/get-video-details) to fetch additional details such as status
+    """

magic_hour/types/models/v1_face_detection_create_response.py

@@ -0,0 +1,25 @@
+import pydantic
+
+
+class V1FaceDetectionCreateResponse(pydantic.BaseModel):
+    """
+    V1FaceDetectionCreateResponse
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The credits charged for the task.
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    The id of the task. Use this value in the [get face detection details API](/api-reference/files/get-face-detection-details) to get the details of the face detection task.
+    """

magic_hour/types/models/v1_face_detection_get_response.py

@@ -0,0 +1,45 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_face_detection_get_response_faces_item import (
+    V1FaceDetectionGetResponseFacesItem,
+)
+
+
+class V1FaceDetectionGetResponse(pydantic.BaseModel):
+    """
+    V1FaceDetectionGetResponse
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The credits charged for the task.
+    """
+    faces: typing.List[V1FaceDetectionGetResponseFacesItem] = pydantic.Field(
+        alias="faces",
+    )
+    """
+    The faces detected in the image or video. The list is populated as faces are detected.
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    The id of the task. This value is returned by the [face detection API](/api-reference/files/face-detection#response-id).
+    """
+    status: typing_extensions.Literal["complete", "error", "queued", "rendering"] = (
+        pydantic.Field(
+            alias="status",
+        )
+    )
+    """
+    The status of the detection.
+    """

magic_hour/types/models/v1_face_detection_get_response_faces_item.py

@@ -0,0 +1,25 @@
+import pydantic
+
+
+class V1FaceDetectionGetResponseFacesItem(pydantic.BaseModel):
+    """
+    V1FaceDetectionGetResponseFacesItem
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    path: str = pydantic.Field(
+        alias="path",
+    )
+    """
+    The path to the face image. This should be used in face swap photo/video API calls as `.assets.face_mappings.original_face`
+    """
+    url: str = pydantic.Field(
+        alias="url",
+    )
+    """
+    The url to the face image. This is used to render the image in your applications.
+    """

magic_hour/types/models/v1_face_swap_create_response.py

@@ -0,0 +1,35 @@
+import pydantic
+
+
+class V1FaceSwapCreateResponse(pydantic.BaseModel):
+    """
+    Success
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the video. If the status is not 'complete', this value is an estimate and may be adjusted upon completion based on the actual FPS of the output video. 
+    
+    If video generation fails, credits will be refunded, and this field will be updated to include the refund.
+    """
+    estimated_frame_cost: int = pydantic.Field(
+        alias="estimated_frame_cost",
+    )
+    """
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for video generation. Use 'credits_charged' instead.
+    
+    The amount of frames used to generate the video. If the status is not 'complete', the cost is an estimate and will be adjusted when the video completes.
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    Unique ID of the video. This value can be used in the [get video project API](https://docs.magichour.ai/api-reference/video-projects/get-video-details) to fetch additional details such as status
+    """

magic_hour/types/models/v1_face_swap_photo_create_response.py

@@ -0,0 +1,33 @@
+import pydantic
+
+
+class V1FaceSwapPhotoCreateResponse(pydantic.BaseModel):
+    """
+    Success
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
+    frame_cost: int = pydantic.Field(
+        alias="frame_cost",
+    )
+    """
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    Unique ID of the image. This value can be used in the [get image project API](https://docs.magichour.ai/api-reference/image-projects/get-image-details) to fetch additional details such as status
+    """

magic_hour/types/models/v1_files_upload_urls_create_response.py

@@ -0,0 +1,24 @@
+import pydantic
+import typing
+
+from .v1_files_upload_urls_create_response_items_item import (
+    V1FilesUploadUrlsCreateResponseItemsItem,
+)
+
+
+class V1FilesUploadUrlsCreateResponse(pydantic.BaseModel):
+    """
+    Success
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    items: typing.List[V1FilesUploadUrlsCreateResponseItemsItem] = pydantic.Field(
+        alias="items",
+    )
+    """
+    The list of upload URLs and file paths for the assets. The response array will match the order of items in the request body. Refer to the [Input Files Guide](/integration/input-files) for more details.
+    """

magic_hour/types/models/{post_v1_files_upload_urls_response_items_item.py → v1_files_upload_urls_create_response_items_item.py}

@@ -1,9 +1,9 @@
 import pydantic
 
 
-class PostV1FilesUploadUrlsResponseItemsItem(pydantic.BaseModel):
+class V1FilesUploadUrlsCreateResponseItemsItem(pydantic.BaseModel):
     """
-    PostV1FilesUploadUrlsResponseItemsItem
+    V1FilesUploadUrlsCreateResponseItemsItem
     """
 
     model_config = pydantic.ConfigDict(

magic_hour/types/models/v1_image_background_remover_create_response.py

@@ -0,0 +1,33 @@
+import pydantic
+
+
+class V1ImageBackgroundRemoverCreateResponse(pydantic.BaseModel):
+    """
+    Success
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
+    frame_cost: int = pydantic.Field(
+        alias="frame_cost",
+    )
+    """
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    Unique ID of the image. This value can be used in the [get image project API](https://docs.magichour.ai/api-reference/image-projects/get-image-details) to fetch additional details such as status
+    """

magic_hour/types/models/{get_v1_image_projects_id_response.py → v1_image_projects_get_response.py}

@@ -2,13 +2,13 @@ import pydantic
 import typing
 import typing_extensions
 
-from .get_v1_image_projects_id_response_downloads_item import (
-    GetV1ImageProjectsIdResponseDownloadsItem,
+from .v1_image_projects_get_response_downloads_item import (
+    V1ImageProjectsGetResponseDownloadsItem,
 )
-from .get_v1_image_projects_id_response_error import GetV1ImageProjectsIdResponseError
+from .v1_image_projects_get_response_error import V1ImageProjectsGetResponseError
 
 
-class GetV1ImageProjectsIdResponse(pydantic.BaseModel):
+class V1ImageProjectsGetResponse(pydantic.BaseModel):
     """
     Success
     """
@@ -21,7 +21,15 @@ class GetV1ImageProjectsIdResponse(pydantic.BaseModel):
     created_at: str = pydantic.Field(
         alias="created_at",
     )
-    downloads: typing.List[GetV1ImageProjectsIdResponseDownloadsItem] = pydantic.Field(
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
+    downloads: typing.List[V1ImageProjectsGetResponseDownloadsItem] = pydantic.Field(
         alias="downloads",
     )
     enabled: bool = pydantic.Field(
@@ -30,7 +38,7 @@ class GetV1ImageProjectsIdResponse(pydantic.BaseModel):
     """
     Indicates whether the resource is deleted
     """
-    error: typing.Optional[GetV1ImageProjectsIdResponseError] = pydantic.Field(
+    error: typing.Optional[V1ImageProjectsGetResponseError] = pydantic.Field(
         alias="error",
     )
     """
@@ -66,17 +74,11 @@ class GetV1ImageProjectsIdResponse(pydantic.BaseModel):
         alias="total_frame_cost",
     )
     """
-    The amount of frames used to generate the image.
-    """
-    type_field: typing_extensions.Literal[
-        "AI_HEADSHOT",
-        "AI_IMAGE",
-        "BACKGROUND_REMOVER",
-        "CLOTHES_CHANGER",
-        "FACE_SWAP",
-        "IMAGE_UPSCALER",
-        "PHOTO_EDITOR",
-        "QR_CODE",
-    ] = pydantic.Field(
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
+    """
+    type_: str = pydantic.Field(
         alias="type",
     )
+    """
+    The type of the image project. Possible values are AI_HEADSHOT, AI_IMAGE, IMAGE_UPSCALER, FACE_SWAP, PHOTO_EDITOR, QR_CODE, BACKGROUND_REMOVER, CLOTHES_CHANGER, AI_MEME, FACE_EDITOR, PHOTO_COLORIZER, AI_GIF, AI_SELFIE, AI_IMAGE_EDITOR
+    """

magic_hour/types/models/{get_v1_video_projects_id_response_downloads_item.py → v1_image_projects_get_response_downloads_item.py}

@@ -1,7 +1,7 @@
 import pydantic
 
 
-class GetV1VideoProjectsIdResponseDownloadsItem(pydantic.BaseModel):
+class V1ImageProjectsGetResponseDownloadsItem(pydantic.BaseModel):
     """
     The download url and expiration date of the image project
     """

magic_hour/types/models/{get_v1_video_projects_id_response_error.py → v1_image_projects_get_response_error.py}

@@ -1,7 +1,7 @@
 import pydantic
 
 
-class GetV1VideoProjectsIdResponseError(pydantic.BaseModel):
+class V1ImageProjectsGetResponseError(pydantic.BaseModel):
     """
     In the case of an error, this object will contain the error encountered during video render
     """
@@ -11,7 +11,7 @@ class GetV1VideoProjectsIdResponseError(pydantic.BaseModel):
         populate_by_name=True,
     )
 
-    code_field: str = pydantic.Field(
+    code: str = pydantic.Field(
         alias="code",
     )
     """

magic_hour/types/models/v1_image_to_video_create_response.py

@@ -0,0 +1,35 @@
+import pydantic
+
+
+class V1ImageToVideoCreateResponse(pydantic.BaseModel):
+    """
+    Success
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the video. If the status is not 'complete', this value is an estimate and may be adjusted upon completion based on the actual FPS of the output video. 
+    
+    If video generation fails, credits will be refunded, and this field will be updated to include the refund.
+    """
+    estimated_frame_cost: int = pydantic.Field(
+        alias="estimated_frame_cost",
+    )
+    """
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for video generation. Use 'credits_charged' instead.
+    
+    The amount of frames used to generate the video. If the status is not 'complete', the cost is an estimate and will be adjusted when the video completes.
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    Unique ID of the video. This value can be used in the [get video project API](https://docs.magichour.ai/api-reference/video-projects/get-video-details) to fetch additional details such as status
+    """

magic_hour/types/models/v1_lip_sync_create_response.py

@@ -0,0 +1,35 @@
+import pydantic
+
+
+class V1LipSyncCreateResponse(pydantic.BaseModel):
+    """
+    Success
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the video. If the status is not 'complete', this value is an estimate and may be adjusted upon completion based on the actual FPS of the output video. 
+    
+    If video generation fails, credits will be refunded, and this field will be updated to include the refund.
+    """
+    estimated_frame_cost: int = pydantic.Field(
+        alias="estimated_frame_cost",
+    )
+    """
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for video generation. Use 'credits_charged' instead.
+    
+    The amount of frames used to generate the video. If the status is not 'complete', the cost is an estimate and will be adjusted when the video completes.
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    Unique ID of the video. This value can be used in the [get video project API](https://docs.magichour.ai/api-reference/video-projects/get-video-details) to fetch additional details such as status
+    """

magic_hour/types/models/v1_photo_colorizer_create_response.py

@@ -0,0 +1,33 @@
+import pydantic
+
+
+class V1PhotoColorizerCreateResponse(pydantic.BaseModel):
+    """
+    Success
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
+    frame_cost: int = pydantic.Field(
+        alias="frame_cost",
+    )
+    """
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    Unique ID of the image. This value can be used in the [get image project API](https://docs.magichour.ai/api-reference/image-projects/get-image-details) to fetch additional details such as status
+    """

magic_hour/types/models/v1_text_to_video_create_response.py

@@ -0,0 +1,35 @@
+import pydantic
+
+
+class V1TextToVideoCreateResponse(pydantic.BaseModel):
+    """
+    Success
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the video. If the status is not 'complete', this value is an estimate and may be adjusted upon completion based on the actual FPS of the output video. 
+    
+    If video generation fails, credits will be refunded, and this field will be updated to include the refund.
+    """
+    estimated_frame_cost: int = pydantic.Field(
+        alias="estimated_frame_cost",
+    )
+    """
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for video generation. Use 'credits_charged' instead.
+    
+    The amount of frames used to generate the video. If the status is not 'complete', the cost is an estimate and will be adjusted when the video completes.
+    """
+    id: str = pydantic.Field(
+        alias="id",
+    )
+    """
+    Unique ID of the video. This value can be used in the [get video project API](https://docs.magichour.ai/api-reference/video-projects/get-video-details) to fetch additional details such as status
+    """