frameio 0.0.23__py3-none-any.whl

frameio/types/metadata_field.py

@@ -0,0 +1,145 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .multi_user_value_member_options_type import MultiUserValueMemberOptionsType
+from .select_option import SelectOption
+from .single_user_value_member_options_type import SingleUserValueMemberOptionsType
+from .user_value import UserValue
+
+
+class MetadataField_Date(UniversalBaseModel):
+    field_type: typing.Literal["date"] = "date"
+    value: typing.Optional[str] = None
+    field_definition_id: str
+    field_definition_name: str
+    mutable: bool
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+
+
+class MetadataField_LongText(UniversalBaseModel):
+    field_type: typing.Literal["long_text"] = "long_text"
+    value: typing.Optional[str] = None
+    field_definition_id: str
+    field_definition_name: str
+    mutable: bool
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+
+
+class MetadataField_Number(UniversalBaseModel):
+    field_type: typing.Literal["number"] = "number"
+    value: typing.Optional[float] = None
+    field_definition_id: str
+    field_definition_name: str
+    mutable: bool
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+
+
+class MetadataField_Rating(UniversalBaseModel):
+    field_type: typing.Literal["rating"] = "rating"
+    value: typing.Optional[int] = None
+    field_definition_id: str
+    field_definition_name: str
+    mutable: bool
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+
+
+class MetadataField_Select(UniversalBaseModel):
+    field_type: typing.Literal["select"] = "select"
+    field_options: typing.Optional[typing.List[SelectOption]] = None
+    value: typing.Optional[typing.List[SelectOption]] = None
+    field_definition_id: str
+    field_definition_name: str
+    mutable: bool
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+
+
+class MetadataField_SelectMulti(UniversalBaseModel):
+    field_type: typing.Literal["select_multi"] = "select_multi"
+    field_options: typing.Optional[typing.List[SelectOption]] = None
+    value: typing.Optional[typing.List[SelectOption]] = None
+    field_definition_id: str
+    field_definition_name: str
+    mutable: bool
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+
+
+class MetadataField_Text(UniversalBaseModel):
+    field_type: typing.Literal["text"] = "text"
+    value: typing.Optional[str] = None
+    field_definition_id: str
+    field_definition_name: str
+    mutable: bool
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+
+
+class MetadataField_Toggle(UniversalBaseModel):
+    field_type: typing.Literal["toggle"] = "toggle"
+    value: typing.Optional[bool] = None
+    field_definition_id: str
+    field_definition_name: str
+    mutable: bool
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+
+
+class MetadataField_UserMulti(UniversalBaseModel):
+    field_type: typing.Literal["user_multi"] = "user_multi"
+    custom_members: typing.Optional[typing.List[UserValue]] = None
+    member_options_type: typing.Optional[MultiUserValueMemberOptionsType] = None
+    value: typing.Optional[typing.List[UserValue]] = None
+    field_definition_id: str
+    field_definition_name: str
+    mutable: bool
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+
+
+class MetadataField_UserSingle(UniversalBaseModel):
+    field_type: typing.Literal["user_single"] = "user_single"
+    custom_members: typing.Optional[typing.List[UserValue]] = None
+    member_options_type: typing.Optional[SingleUserValueMemberOptionsType] = None
+    value: typing.Optional[typing.List[UserValue]] = None
+    field_definition_id: str
+    field_definition_name: str
+    mutable: bool
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+
+
+class MetadataField_Users(UniversalBaseModel):
+    field_type: typing.Literal["users"] = "users"
+    custom_members: typing.Optional[typing.List[UserValue]] = None
+    member_options_type: typing.Optional[MultiUserValueMemberOptionsType] = None
+    value: typing.Optional[typing.List[UserValue]] = None
+    field_definition_id: str
+    field_definition_name: str
+    mutable: bool
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+
+
+MetadataField = typing.Union[
+    MetadataField_Date,
+    MetadataField_LongText,
+    MetadataField_Number,
+    MetadataField_Rating,
+    MetadataField_Select,
+    MetadataField_SelectMulti,
+    MetadataField_Text,
+    MetadataField_Toggle,
+    MetadataField_UserMulti,
+    MetadataField_UserSingle,
+    MetadataField_Users,
+]

frameio/types/metadata_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 .metadata_with_definition import MetadataWithDefinition
+
+
+class MetadataResponse(UniversalBaseModel):
+    data: MetadataWithDefinition
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/metadata_with_definition.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .metadata_field import MetadataField
+
+
+class MetadataWithDefinition(UniversalBaseModel):
+    file_id: str = pydantic.Field()
+    """
+    File ID
+    """
+
+    metadata: typing.List[MetadataField] = pydantic.Field()
+    """
+    Metadata fields values
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/multi_select_value.py

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

frameio/types/multi_user_value.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from .field_value_common import FieldValueCommon
+from .multi_user_value_member_options_type import MultiUserValueMemberOptionsType
+from .user_value import UserValue
+
+
+class MultiUserValue(FieldValueCommon):
+    custom_members: typing.Optional[typing.List[UserValue]] = pydantic.Field(default=None)
+    """
+    Populated with costum member options only if `member_options_type` is set to 'custom'.
+    """
+
+    member_options_type: typing.Optional[MultiUserValueMemberOptionsType] = None
+    value: typing.Optional[typing.List[UserValue]] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/multi_user_value_member_options_type.py

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

frameio/types/no_content.py

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

frameio/types/not_found.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 .not_found_errors_item import NotFoundErrorsItem
+
+
+class NotFound(UniversalBaseModel):
+    errors: typing.List[NotFoundErrorsItem]
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/not_found_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 .not_found_errors_item_source import NotFoundErrorsItemSource
+
+
+class NotFoundErrorsItem(UniversalBaseModel):
+    detail: str
+    source: typing.Optional[NotFoundErrorsItemSource] = None
+    title: typing.Optional[str] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/not_found_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 NotFoundErrorsItemSource(UniversalBaseModel):
+    pointer: typing.Optional[str] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/number_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 .number_definition_field_configuration import NumberDefinitionFieldConfiguration
+
+
+class NumberDefinition(UniversalBaseModel):
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Created Timestamp
+    """
+
+    creator_id: str = pydantic.Field()
+    """
+    Field definition creator ID
+    """
+
+    field_configuration: NumberDefinitionFieldConfiguration
+    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/number_definition_field_configuration.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .number_definition_field_configuration_number_format import NumberDefinitionFieldConfigurationNumberFormat
+
+
+class NumberDefinitionFieldConfiguration(UniversalBaseModel):
+    number_format: typing.Optional[NumberDefinitionFieldConfigurationNumberFormat] = pydantic.Field(default=None)
+    """
+    Number format
+    """
+
+    scale: int = pydantic.Field()
+    """
+    Number scale. Indicates the number of decimal places of precision for the number value
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/number_definition_field_configuration_number_format.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+NumberDefinitionFieldConfigurationNumberFormat = typing.Union[
+    typing.Literal["bitrate", "bits", "duration", "framerate", "frequency", "storage", "timecode"], typing.Any
+]

frameio/types/number_definition_params.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
+from .number_definition_params_field_configuration import NumberDefinitionParamsFieldConfiguration
+
+
+class NumberDefinitionParams(UniversalBaseModel):
+    field_configuration: NumberDefinitionParamsFieldConfiguration
+    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/number_definition_params_field_configuration.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 .number_definition_params_field_configuration_number_format import (
+    NumberDefinitionParamsFieldConfigurationNumberFormat,
+)
+
+
+class NumberDefinitionParamsFieldConfiguration(UniversalBaseModel):
+    number_format: typing.Optional[NumberDefinitionParamsFieldConfigurationNumberFormat] = pydantic.Field(default=None)
+    """
+    Number format
+    """
+
+    scale: int = pydantic.Field()
+    """
+    Number scale. Indicates the number of decimal places of precision for the number value
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/number_definition_params_field_configuration_number_format.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+NumberDefinitionParamsFieldConfigurationNumberFormat = typing.Union[
+    typing.Literal["bitrate", "bits", "duration", "framerate", "frequency", "storage", "timecode"], typing.Any
+]

frameio/types/number_definition_with_includes.py

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

frameio/types/number_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 NumberValue(FieldValueCommon):
+    value: typing.Optional[float] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/original_media_link.py

@@ -0,0 +1,16 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from .media_link_common import MediaLinkCommon
+
+
+class OriginalMediaLink(MediaLinkCommon):
+    inline_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL to view the media file in a web browser in its original resolution and media type.<br>
+    HTTP response headers will include Content-Disposition = 'inline;filename=<filename>'.<br>
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/profile.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+
+
+class Profile(UniversalBaseModel):
+    """
+    User details
+    """
+
+    avatar_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    User avatar image url
+    """
+
+    email: str = pydantic.Field()
+    """
+    User email
+    """
+
+    id: str = pydantic.Field()
+    """
+    User ID
+    """
+
+    name: str = pydantic.Field()
+    """
+    User name
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/profile_response.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
+from .profile import Profile
+
+
+class ProfileResponse(UniversalBaseModel):
+    """
+    User profile
+    """
+
+    data: Profile
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/project.py

@@ -0,0 +1,55 @@
+# 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 Project(UniversalBaseModel):
+    """
+    Frame.io Project
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Created Timestamp
+    """
+
+    id: str = pydantic.Field()
+    """
+    Project ID
+    """
+
+    name: str = pydantic.Field()
+    """
+    Project Name
+    """
+
+    root_folder_id: str = pydantic.Field()
+    """
+    Root Folder ID
+    """
+
+    storage: int = pydantic.Field()
+    """
+    Storage Usage
+    """
+
+    updated_at: dt.datetime = pydantic.Field()
+    """
+    Updated Timestamp
+    """
+
+    view_url: str = pydantic.Field()
+    """
+    URL to view the project in the Frame.io web application
+    """
+
+    workspace_id: str = pydantic.Field()
+    """
+    Workspace ID
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/project_include.py

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

frameio/types/project_params.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
+from .project_params_data import ProjectParamsData
+
+
+class ProjectParams(UniversalBaseModel):
+    """
+    Project parameters for create operations
+    """
+
+    data: ProjectParamsData
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/project_params_data.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 ProjectParamsData(UniversalBaseModel):
+    name: str = pydantic.Field()
+    """
+    Project Name
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/project_response.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
+from .project import Project
+
+
+class ProjectResponse(UniversalBaseModel):
+    """
+    Frame.io project details
+    """
+
+    data: Project
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/project_with_includes.py

@@ -0,0 +1,18 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from .project import Project
+from .user import User
+
+
+class ProjectWithIncludes(Project):
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Project Description
+    """
+
+    owner: typing.Optional[User] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/project_with_includes_response.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
+from .project_with_includes import ProjectWithIncludes
+
+
+class ProjectWithIncludesResponse(UniversalBaseModel):
+    """
+    Frame.io project details
+    """
+
+    data: ProjectWithIncludes
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2