frameio 0.0.28__py3-none-any.whl

frameio/types/date_definition.py

@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .date_definition_field_configuration import DateDefinitionFieldConfiguration
+from .date_definition_field_type import DateDefinitionFieldType
+
+
+class DateDefinition(UncheckedBaseModel):
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Created Timestamp
+    """
+
+    creator_id: str = pydantic.Field()
+    """
+    Field definition creator ID
+    """
+
+    field_configuration: DateDefinitionFieldConfiguration
+    field_type: DateDefinitionFieldType = pydantic.Field()
+    """
+    Field type
+    """
+
+    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)

frameio/types/date_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.unchecked_base_model import UncheckedBaseModel
+from .date_definition_field_configuration_display_format import DateDefinitionFieldConfigurationDisplayFormat
+from .date_definition_field_configuration_time_format import DateDefinitionFieldConfigurationTimeFormat
+
+
+class DateDefinitionFieldConfiguration(UncheckedBaseModel):
+    display_format: DateDefinitionFieldConfigurationDisplayFormat
+    display_timezone: typing.Optional[bool] = None
+    include_time: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    
+    """
+
+    time_format: typing.Optional[DateDefinitionFieldConfigurationTimeFormat] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/date_definition_field_configuration_display_format.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DateDefinitionFieldConfigurationDisplayFormat = typing.Union[
+    typing.Literal["local", "friendly", "usa", "euro", "iso"], typing.Any
+]

frameio/types/date_definition_field_configuration_time_format.py

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

frameio/types/date_definition_field_type.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DateDefinitionFieldType = typing.Union[
+    typing.Literal[
+        "text", "long_text", "select", "select_multi", "rating", "number", "toggle", "user_single", "user_multi", "date"
+    ],
+    typing.Any,
+]

frameio/types/date_definition_params.py

@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .date_definition_params_field_configuration import DateDefinitionParamsFieldConfiguration
+
+
+class DateDefinitionParams(UncheckedBaseModel):
+    field_configuration: DateDefinitionParamsFieldConfiguration
+    name: str = pydantic.Field()
+    """
+    Field definition name
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/date_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.unchecked_base_model import UncheckedBaseModel
+from .date_definition_params_field_configuration_display_format import (
+    DateDefinitionParamsFieldConfigurationDisplayFormat,
+)
+from .date_definition_params_field_configuration_time_format import DateDefinitionParamsFieldConfigurationTimeFormat
+
+
+class DateDefinitionParamsFieldConfiguration(UncheckedBaseModel):
+    display_format: DateDefinitionParamsFieldConfigurationDisplayFormat
+    display_timezone: typing.Optional[bool] = None
+    include_time: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    
+    """
+
+    time_format: typing.Optional[DateDefinitionParamsFieldConfigurationTimeFormat] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/date_definition_params_field_configuration_display_format.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DateDefinitionParamsFieldConfigurationDisplayFormat = typing.Union[
+    typing.Literal["local", "friendly", "usa", "euro", "iso"], typing.Any
+]

frameio/types/date_definition_params_field_configuration_time_format.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DateDefinitionParamsFieldConfigurationTimeFormat = typing.Union[
+    typing.Literal["twelve_hour", "twenty_four_hour"], typing.Any
+]

frameio/types/date_definition_with_includes.py

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

frameio/types/date_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 DateValue(FieldValueCommon):
+    value: typing.Optional[str] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/email.py

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

frameio/types/empty_json.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+EmptyJson = typing.Dict[str, typing.Any]

frameio/types/field_definition.py

@@ -0,0 +1,167 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.unchecked_base_model import UncheckedBaseModel, UnionMetadata
+from .date_definition_field_configuration import DateDefinitionFieldConfiguration
+from .long_text_definition_field_configuration import LongTextDefinitionFieldConfiguration
+from .number_definition_field_configuration import NumberDefinitionFieldConfiguration
+from .rating_definition_field_configuration import RatingDefinitionFieldConfiguration
+from .select_definition_field_configuration import SelectDefinitionFieldConfiguration
+from .select_multi_definition_field_configuration import SelectMultiDefinitionFieldConfiguration
+from .text_definition_field_configuration import TextDefinitionFieldConfiguration
+from .toggle_definition_field_configuration import ToggleDefinitionFieldConfiguration
+from .user_multi_definition_field_configuration import UserMultiDefinitionFieldConfiguration
+from .user_single_definition_field_configuration import UserSingleDefinitionFieldConfiguration
+
+
+class FieldDefinition_Date(UncheckedBaseModel):
+    field_type: typing.Literal["date"] = "date"
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: DateDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinition_LongText(UncheckedBaseModel):
+    field_type: typing.Literal["long_text"] = "long_text"
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: LongTextDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinition_Number(UncheckedBaseModel):
+    field_type: typing.Literal["number"] = "number"
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: NumberDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinition_Rating(UncheckedBaseModel):
+    field_type: typing.Literal["rating"] = "rating"
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: RatingDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinition_Select(UncheckedBaseModel):
+    field_type: typing.Literal["select"] = "select"
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: SelectDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinition_SelectMulti(UncheckedBaseModel):
+    field_type: typing.Literal["select_multi"] = "select_multi"
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: SelectMultiDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinition_Text(UncheckedBaseModel):
+    field_type: typing.Literal["text"] = "text"
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: TextDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinition_Toggle(UncheckedBaseModel):
+    field_type: typing.Literal["toggle"] = "toggle"
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: ToggleDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinition_UserMulti(UncheckedBaseModel):
+    field_type: typing.Literal["user_multi"] = "user_multi"
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: UserMultiDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinition_UserSingle(UncheckedBaseModel):
+    field_type: typing.Literal["user_single"] = "user_single"
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: UserSingleDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+FieldDefinition = typing_extensions.Annotated[
+    typing.Union[
+        FieldDefinition_Date,
+        FieldDefinition_LongText,
+        FieldDefinition_Number,
+        FieldDefinition_Rating,
+        FieldDefinition_Select,
+        FieldDefinition_SelectMulti,
+        FieldDefinition_Text,
+        FieldDefinition_Toggle,
+        FieldDefinition_UserMulti,
+        FieldDefinition_UserSingle,
+    ],
+    UnionMetadata(discriminant="field_type"),
+]

frameio/types/field_definition_include.py

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

frameio/types/field_definition_response.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .field_definition import FieldDefinition
+
+
+class FieldDefinitionResponse(UncheckedBaseModel):
+    data: FieldDefinition
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/field_definition_with_includes.py

@@ -0,0 +1,178 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.unchecked_base_model import UncheckedBaseModel, UnionMetadata
+from .date_definition_field_configuration import DateDefinitionFieldConfiguration
+from .long_text_definition_field_configuration import LongTextDefinitionFieldConfiguration
+from .number_definition_field_configuration import NumberDefinitionFieldConfiguration
+from .rating_definition_field_configuration import RatingDefinitionFieldConfiguration
+from .select_definition_field_configuration import SelectDefinitionFieldConfiguration
+from .select_multi_definition_field_configuration import SelectMultiDefinitionFieldConfiguration
+from .text_definition_field_configuration import TextDefinitionFieldConfiguration
+from .toggle_definition_field_configuration import ToggleDefinitionFieldConfiguration
+from .user import User
+from .user_multi_definition_field_configuration import UserMultiDefinitionFieldConfiguration
+from .user_single_definition_field_configuration import UserSingleDefinitionFieldConfiguration
+
+
+class FieldDefinitionWithIncludes_Date(UncheckedBaseModel):
+    field_type: typing.Literal["date"] = "date"
+    creator: typing.Optional[User] = None
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: DateDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinitionWithIncludes_LongText(UncheckedBaseModel):
+    field_type: typing.Literal["long_text"] = "long_text"
+    creator: typing.Optional[User] = None
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: LongTextDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinitionWithIncludes_Number(UncheckedBaseModel):
+    field_type: typing.Literal["number"] = "number"
+    creator: typing.Optional[User] = None
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: NumberDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinitionWithIncludes_Rating(UncheckedBaseModel):
+    field_type: typing.Literal["rating"] = "rating"
+    creator: typing.Optional[User] = None
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: RatingDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinitionWithIncludes_Select(UncheckedBaseModel):
+    field_type: typing.Literal["select"] = "select"
+    creator: typing.Optional[User] = None
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: SelectDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinitionWithIncludes_SelectMulti(UncheckedBaseModel):
+    field_type: typing.Literal["select_multi"] = "select_multi"
+    creator: typing.Optional[User] = None
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: SelectMultiDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinitionWithIncludes_Text(UncheckedBaseModel):
+    field_type: typing.Literal["text"] = "text"
+    creator: typing.Optional[User] = None
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: TextDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinitionWithIncludes_Toggle(UncheckedBaseModel):
+    field_type: typing.Literal["toggle"] = "toggle"
+    creator: typing.Optional[User] = None
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: ToggleDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinitionWithIncludes_UserMulti(UncheckedBaseModel):
+    field_type: typing.Literal["user_multi"] = "user_multi"
+    creator: typing.Optional[User] = None
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: UserMultiDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class FieldDefinitionWithIncludes_UserSingle(UncheckedBaseModel):
+    field_type: typing.Literal["user_single"] = "user_single"
+    creator: typing.Optional[User] = None
+    created_at: dt.datetime
+    creator_id: str
+    field_configuration: UserSingleDefinitionFieldConfiguration
+    id: str
+    mutable: bool
+    name: str
+    updated_at: dt.datetime
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+FieldDefinitionWithIncludes = typing_extensions.Annotated[
+    typing.Union[
+        FieldDefinitionWithIncludes_Date,
+        FieldDefinitionWithIncludes_LongText,
+        FieldDefinitionWithIncludes_Number,
+        FieldDefinitionWithIncludes_Rating,
+        FieldDefinitionWithIncludes_Select,
+        FieldDefinitionWithIncludes_SelectMulti,
+        FieldDefinitionWithIncludes_Text,
+        FieldDefinitionWithIncludes_Toggle,
+        FieldDefinitionWithIncludes_UserMulti,
+        FieldDefinitionWithIncludes_UserSingle,
+    ],
+    UnionMetadata(discriminant="field_type"),
+]

frameio/types/field_definitions_with_includes_response.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .field_definition_with_includes import FieldDefinitionWithIncludes
+from .links import Links
+
+
+class FieldDefinitionsWithIncludesResponse(UncheckedBaseModel):
+    """
+    Account field definitions
+    """
+
+    data: typing.List[FieldDefinitionWithIncludes] = pydantic.Field()
+    """
+    Field definitions
+    """
+
+    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)

frameio/types/field_value_common.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class FieldValueCommon(UncheckedBaseModel):
+    """
+    Metadata field value
+    """
+
+    field_definition_id: str = pydantic.Field()
+    """
+    Field definition ID
+    """
+
+    field_definition_name: str = pydantic.Field()
+    """
+    Field definition name
+    """
+
+    mutable: bool = pydantic.Field()
+    """
+    Metadata mutability. System field values cannot be updated.
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/file.py

@@ -0,0 +1,60 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .asset_common_type import AssetCommonType
+from .file_status import FileStatus
+
+
+class File(UncheckedBaseModel):
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    File ID
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    File Name
+    """
+
+    file_size: int = pydantic.Field()
+    """
+    File size in bytes
+    """
+
+    media_type: str = pydantic.Field()
+    """
+    File media type
+    """
+
+    status: FileStatus
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Creation timestamp
+    """
+
+    parent_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Parent Folder or Version Stack ID
+    """
+
+    project_id: str = pydantic.Field()
+    """
+    Project ID
+    """
+
+    type: AssetCommonType
+    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)