frameio 0.0.23__py3-none-any.whl

frameio/types/file_response.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .file import File
+
+
+class FileResponse(UniversalBaseModel):
+    data: File
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/file_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+FileStatus = typing.Union[typing.Literal["created", "transcoded", "uploaded"], typing.Any]

frameio/types/file_upload_status.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+
+
+class FileUploadStatus(UniversalBaseModel):
+    filetype: str = pydantic.Field()
+    """
+    File type
+    """
+
+    id: str = pydantic.Field()
+    """
+    File ID
+    """
+
+    upload_complete: bool = pydantic.Field()
+    """
+    Indicates if upload is complete
+    """
+
+    upload_completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp when the asset was successfully uploaded
+    """
+
+    upload_failed: bool = pydantic.Field()
+    """
+    Indicates if upload failed
+    """
+
+    uploaded_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp when the operation started
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/file_upload_status_response.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .file_upload_status import FileUploadStatus
+
+
+class FileUploadStatusResponse(UniversalBaseModel):
+    data: FileUploadStatus
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/file_with_includes.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from .asset_common_with_includes import AssetCommonWithIncludes
+from .file_with_includes_status import FileWithIncludesStatus
+from .media_links_collection import MediaLinksCollection
+
+
+class FileWithIncludes(AssetCommonWithIncludes):
+    file_size: int = pydantic.Field()
+    """
+    File size in bytes
+    """
+
+    media_links: typing.Optional[MediaLinksCollection] = None
+    media_type: str = pydantic.Field()
+    """
+    File media type
+    """
+
+    status: FileWithIncludesStatus
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/file_with_includes_response.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .file_with_includes import FileWithIncludes
+
+
+class FileWithIncludesResponse(UniversalBaseModel):
+    data: FileWithIncludes
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/file_with_includes_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+FileWithIncludesStatus = typing.Union[typing.Literal["created", "transcoded", "uploaded"], typing.Any]

frameio/types/file_with_media_links_include.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+FileWithMediaLinksInclude = typing.Union[
+    typing.Literal[
+        "media_links",
+        "media_links.original",
+        "media_links.thumbnail",
+        "media_links.video_h264_180",
+        "media_links.high_quality",
+        "media_links.efficient",
+        "creator",
+        "project",
+        "project.owner",
+        "metadata",
+    ],
+    typing.Any,
+]

frameio/types/file_with_upload_urls.py

@@ -0,0 +1,16 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from .file import File
+from .upload_url import UploadUrl
+
+
+class FileWithUploadUrls(File):
+    upload_urls: typing.Optional[typing.List[UploadUrl]] = pydantic.Field(default=None)
+    """
+    File upload URLs. Number of URLs returned will vary depending on the file size.
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/file_with_upload_urls_response.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .file_with_upload_urls import FileWithUploadUrls
+
+
+class FileWithUploadUrlsResponse(UniversalBaseModel):
+    data: FileWithUploadUrls
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/folder.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from .asset_common import AssetCommon
+
+
+class Folder(AssetCommon):
+    cover_file_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cover asset ID
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/folder_copy_response.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .folder import Folder
+
+
+class FolderCopyResponse(UniversalBaseModel):
+    data: Folder
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/folder_response.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .folder import Folder
+
+
+class FolderResponse(UniversalBaseModel):
+    data: Folder
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/folder_with_includes.py

@@ -0,0 +1,61 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .metadata_field import MetadataField
+from .project_with_includes import ProjectWithIncludes
+from .user import User
+
+
+class FolderWithIncludes(UniversalBaseModel):
+    cover_file_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cover asset ID
+    """
+
+    parent_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Parent Folder ID
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Creation timestamp
+    """
+
+    creator: typing.Optional[User] = None
+    id: str = pydantic.Field()
+    """
+    File, Folder, or Version Stack ID
+    """
+
+    metadata: typing.Optional[typing.List[MetadataField]] = pydantic.Field(default=None)
+    """
+    File attributes
+    """
+
+    name: str = pydantic.Field()
+    """
+    File or Folder Name
+    """
+
+    project: typing.Optional[ProjectWithIncludes] = None
+    project_id: str = pydantic.Field()
+    """
+    Project ID
+    """
+
+    updated_at: dt.datetime = pydantic.Field()
+    """
+    Update timestamp
+    """
+
+    view_url: str = pydantic.Field()
+    """
+    URL to view the asset in the Frame.io web application
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/folder_with_includes_response.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .folder_with_includes import FolderWithIncludes
+
+
+class FolderWithIncludesResponse(UniversalBaseModel):
+    data: FolderWithIncludes
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/folders_with_includes_response.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .folder_with_includes import FolderWithIncludes
+from .links import Links
+
+
+class FoldersWithIncludesResponse(UniversalBaseModel):
+    data: typing.List[FolderWithIncludes] = pydantic.Field()
+    """
+    Folders
+    """
+
+    links: Links
+    total_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total count
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/forbidden.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .forbidden_errors_item import ForbiddenErrorsItem
+
+
+class Forbidden(UniversalBaseModel):
+    errors: typing.List[ForbiddenErrorsItem]
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/forbidden_errors_item.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .forbidden_errors_item_source import ForbiddenErrorsItemSource
+
+
+class ForbiddenErrorsItem(UniversalBaseModel):
+    detail: str
+    source: typing.Optional[ForbiddenErrorsItemSource] = None
+    title: typing.Optional[str] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/forbidden_errors_item_source.py

@@ -0,0 +1,12 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+
+
+class ForbiddenErrorsItemSource(UniversalBaseModel):
+    pointer: typing.Optional[str] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/include.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+Include = typing.Literal["creator"]

frameio/types/include_total_count.py

@@ -0,0 +1,3 @@
+# This file was auto-generated by Fern from our API Definition.
+
+IncludeTotalCount = bool

frameio/types/integer_value.py

@@ -0,0 +1,12 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from .field_value_common import FieldValueCommon
+
+
+class IntegerValue(FieldValueCommon):
+    value: typing.Optional[int] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/json_error_response.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .json_error_response_errors_item import JsonErrorResponseErrorsItem
+
+
+class JsonErrorResponse(UniversalBaseModel):
+    errors: typing.List[JsonErrorResponseErrorsItem]
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/json_error_response_errors_item.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .json_error_response_errors_item_source import JsonErrorResponseErrorsItemSource
+
+
+class JsonErrorResponseErrorsItem(UniversalBaseModel):
+    detail: str
+    source: JsonErrorResponseErrorsItemSource
+    title: str
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/json_error_response_errors_item_source.py

@@ -0,0 +1,12 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+
+
+class JsonErrorResponseErrorsItemSource(UniversalBaseModel):
+    pointer: str
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/links.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+
+
+class Links(UniversalBaseModel):
+    """
+    Links to paginated data
+    """
+
+    next: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    "Link to next page of data.
+    <br/>
+    This link is the request path with the addition of the `after` query parameter to fetch the next page of results.
+    Optional query parameters `page_size` and `include_total_count` are supported when paginating data."
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/long_text_definition.py

@@ -0,0 +1,43 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .long_text_definition_field_configuration import LongTextDefinitionFieldConfiguration
+
+
+class LongTextDefinition(UniversalBaseModel):
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Created Timestamp
+    """
+
+    creator_id: str = pydantic.Field()
+    """
+    Field definition creator ID
+    """
+
+    field_configuration: LongTextDefinitionFieldConfiguration
+    id: str = pydantic.Field()
+    """
+    Field definition ID
+    """
+
+    mutable: bool = pydantic.Field()
+    """
+    Field definition mutability. System fields cannot be updated.
+    """
+
+    name: str = pydantic.Field()
+    """
+    FieldDefinition Name
+    """
+
+    updated_at: dt.datetime = pydantic.Field()
+    """
+    Updated Timestamp
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/long_text_definition_field_configuration.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+
+
+class LongTextDefinitionFieldConfiguration(UniversalBaseModel):
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/long_text_definition_params.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+
+
+class LongTextDefinitionParams(UniversalBaseModel):
+    name: str = pydantic.Field()
+    """
+    Field definition name
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/long_text_definition_with_includes.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from .long_text_definition import LongTextDefinition
+from .user import User
+
+
+class LongTextDefinitionWithIncludes(LongTextDefinition):
+    creator: typing.Optional[User] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/media_link_common.py

@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+
+
+class MediaLinkCommon(UniversalBaseModel):
+    download_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL to download the media file.<br>
+    HTTP response headers will include Content-Disposition = 'attachment;filename=<filename>'.<br>
+    Watermarks may be applied for transcode links as per Account settings and User permissions.<br>
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/media_links_collection.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .media_link_common import MediaLinkCommon
+from .original_media_link import OriginalMediaLink
+from .rendition_media_link import RenditionMediaLink
+
+
+class MediaLinksCollection(UniversalBaseModel):
+    efficient: typing.Optional[MediaLinkCommon] = None
+    high_quality: typing.Optional[MediaLinkCommon] = None
+    original: typing.Optional[OriginalMediaLink] = None
+    thumbnail: typing.Optional[RenditionMediaLink] = None
+    video_h_264_180: typing_extensions.Annotated[
+        typing.Optional[RenditionMediaLink], FieldMetadata(alias="video_h264_180")
+    ] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2