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

magic_hour/types/models/{get_v1_video_projects_id_response.py → v1_video_projects_get_response.py}

@@ -2,16 +2,14 @@ import pydantic
 import typing
 import typing_extensions
 
-from .get_v1_video_projects_id_response_download import (
-    GetV1VideoProjectsIdResponseDownload,
+from .v1_video_projects_get_response_download import V1VideoProjectsGetResponseDownload
+from .v1_video_projects_get_response_downloads_item import (
+    V1VideoProjectsGetResponseDownloadsItem,
 )
-from .get_v1_video_projects_id_response_downloads_item import (
-    GetV1VideoProjectsIdResponseDownloadsItem,
-)
-from .get_v1_video_projects_id_response_error import GetV1VideoProjectsIdResponseError
+from .v1_video_projects_get_response_error import V1VideoProjectsGetResponseError
 
 
-class GetV1VideoProjectsIdResponse(pydantic.BaseModel):
+class V1VideoProjectsGetResponse(pydantic.BaseModel):
     """
     Success
     """
@@ -24,13 +22,21 @@ class GetV1VideoProjectsIdResponse(pydantic.BaseModel):
     created_at: str = pydantic.Field(
         alias="created_at",
     )
-    download: typing.Optional[GetV1VideoProjectsIdResponseDownload] = pydantic.Field(
+    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.
+    """
+    download: typing.Optional[V1VideoProjectsGetResponseDownload] = pydantic.Field(
         alias="download",
     )
     """
     Deprecated: Please use `.downloads` instead. The download url and expiration date of the video project
     """
-    downloads: typing.List[GetV1VideoProjectsIdResponseDownloadsItem] = pydantic.Field(
+    downloads: typing.List[V1VideoProjectsGetResponseDownloadsItem] = pydantic.Field(
         alias="downloads",
     )
     enabled: bool = pydantic.Field(
@@ -43,9 +49,9 @@ class GetV1VideoProjectsIdResponse(pydantic.BaseModel):
         alias="end_seconds",
     )
     """
-    The end time of the input video in 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.
     """
-    error: typing.Optional[GetV1VideoProjectsIdResponseError] = pydantic.Field(
+    error: typing.Optional[V1VideoProjectsGetResponseError] = pydantic.Field(
         alias="error",
     )
     """
@@ -61,7 +67,7 @@ class GetV1VideoProjectsIdResponse(pydantic.BaseModel):
         alias="height",
     )
     """
-    The height of the final output video. The maximum height depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details
+    The height of the final output video. A value of -1 indicates the height can be ignored.
     """
     id: str = pydantic.Field(
         alias="id",
@@ -79,7 +85,7 @@ class GetV1VideoProjectsIdResponse(pydantic.BaseModel):
         alias="start_seconds",
     )
     """
-    The start time of the input video in seconds
+    The start time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.
     """
     status: typing_extensions.Literal[
         "canceled", "complete", "draft", "error", "queued", "rendering"
@@ -93,22 +99,19 @@ class GetV1VideoProjectsIdResponse(pydantic.BaseModel):
         alias="total_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.
     """
-    type_field: typing_extensions.Literal[
-        "ANIMATION",
-        "AUTO_SUBTITLE",
-        "FACE_SWAP",
-        "IMAGE_TO_VIDEO",
-        "LIP_SYNC",
-        "TEXT_TO_VIDEO",
-        "VIDEO_TO_VIDEO",
-    ] = pydantic.Field(
+    type_: str = pydantic.Field(
         alias="type",
     )
+    """
+    The type of the video project. Possible values are ANIMATION, IMAGE_TO_VIDEO, VIDEO_TO_VIDEO, TEXT_TO_VIDEO, FACE_SWAP, LIP_SYNC, AUTO_SUBTITLE, TALKING_PHOTO, UGC_AD
+    """
     width: int = pydantic.Field(
         alias="width",
     )
     """
-    The width of the final output video. The maximum width depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details
+    The width of the final output video. A value of -1 indicates the width can be ignored.
     """

magic_hour/types/models/{get_v1_video_projects_id_response_download.py → v1_video_projects_get_response_download.py}

@@ -1,7 +1,7 @@
 import pydantic
 
 
-class GetV1VideoProjectsIdResponseDownload(pydantic.BaseModel):
+class V1VideoProjectsGetResponseDownload(pydantic.BaseModel):
     """
     Deprecated: Please use `.downloads` instead. The download url and expiration date of the video project
     """

magic_hour/types/models/{get_v1_image_projects_id_response_downloads_item.py → v1_video_projects_get_response_downloads_item.py}

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

magic_hour/types/models/v1_video_projects_get_response_error.py

@@ -0,0 +1,25 @@
+import pydantic
+
+
+class V1VideoProjectsGetResponseError(pydantic.BaseModel):
+    """
+    In the case of an error, this object will contain the error encountered during video render
+    """
+
+    model_config = pydantic.ConfigDict(
+        arbitrary_types_allowed=True,
+        populate_by_name=True,
+    )
+
+    code: str = pydantic.Field(
+        alias="code",
+    )
+    """
+    An error code to indicate why a failure happened.
+    """
+    message: str = pydantic.Field(
+        alias="message",
+    )
+    """
+    Details on the reason why a failure happened.
+    """

magic_hour/types/models/v1_video_to_video_create_response.py

@@ -0,0 +1,35 @@
+import pydantic
+
+
+class V1VideoToVideoCreateResponse(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
+    """