frameio 0.0.23__py3-none-any.whl

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

frameio/types/share_reviewers_response.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .links import Links
+from .user import User
+
+
+class ShareReviewersResponse(UniversalBaseModel):
+    """
+    Share reviewers
+    """
+
+    data: typing.List[User] = pydantic.Field()
+    """
+    Share reviewer details
+    """
+
+    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/shares_response.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .links import Links
+from .share import Share
+
+
+class SharesResponse(UniversalBaseModel):
+    """
+    Shares on a project
+    """
+
+    data: typing.List[Share] = pydantic.Field()
+    """
+    Shares
+    """
+
+    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/single_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 .single_user_value_member_options_type import SingleUserValueMemberOptionsType
+from .user_value import UserValue
+
+
+class SingleUserValue(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[SingleUserValueMemberOptionsType] = 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/single_user_value_member_options_type.py

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

frameio/types/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 .text_definition_field_configuration import TextDefinitionFieldConfiguration
+
+
+class TextDefinition(UniversalBaseModel):
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Created Timestamp
+    """
+
+    creator_id: str = pydantic.Field()
+    """
+    Field definition creator ID
+    """
+
+    field_configuration: TextDefinitionFieldConfiguration
+    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/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 TextDefinitionFieldConfiguration(UniversalBaseModel):
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/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 TextDefinitionParams(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/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 .text_definition import TextDefinition
+from .user import User
+
+
+class TextDefinitionWithIncludes(TextDefinition):
+    creator: typing.Optional[User] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

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

frameio/types/toggle_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 .toggle_definition_field_configuration import ToggleDefinitionFieldConfiguration
+
+
+class ToggleDefinition(UniversalBaseModel):
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Created Timestamp
+    """
+
+    creator_id: str = pydantic.Field()
+    """
+    Field definition creator ID
+    """
+
+    field_configuration: ToggleDefinitionFieldConfiguration
+    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/toggle_definition_field_configuration.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 ToggleDefinitionFieldConfiguration(UniversalBaseModel):
+    color: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Color value hex code. ex: #fbd400
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/toggle_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 .toggle_definition_params_field_configuration import ToggleDefinitionParamsFieldConfiguration
+
+
+class ToggleDefinitionParams(UniversalBaseModel):
+    field_configuration: typing.Optional[ToggleDefinitionParamsFieldConfiguration] = None
+    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/toggle_definition_params_field_configuration.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 ToggleDefinitionParamsFieldConfiguration(UniversalBaseModel):
+    color: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Color value hex code. ex: #fbd400
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/toggle_definition_with_includes.py

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

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

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

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

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

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

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

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

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

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

frameio/types/update_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.pydantic_utilities import UniversalBaseModel
+from .update_date_definition_params_field_configuration import UpdateDateDefinitionParamsFieldConfiguration
+
+
+class UpdateDateDefinitionParams(UniversalBaseModel):
+    field_configuration: typing.Optional[UpdateDateDefinitionParamsFieldConfiguration] = None
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Field definition name
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/update_date_definition_params_field_configuration.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .update_date_definition_params_field_configuration_display_format import (
+    UpdateDateDefinitionParamsFieldConfigurationDisplayFormat,
+)
+from .update_date_definition_params_field_configuration_time_format import (
+    UpdateDateDefinitionParamsFieldConfigurationTimeFormat,
+)
+
+
+class UpdateDateDefinitionParamsFieldConfiguration(UniversalBaseModel):
+    display_format: typing.Optional[UpdateDateDefinitionParamsFieldConfigurationDisplayFormat] = None
+    display_timezone: typing.Optional[bool] = None
+    include_time: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    
+    """
+
+    time_format: typing.Optional[UpdateDateDefinitionParamsFieldConfigurationTimeFormat] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/update_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
+
+UpdateDateDefinitionParamsFieldConfigurationDisplayFormat = typing.Union[
+    typing.Literal["local", "friendly", "usa", "euro", "iso"], typing.Any
+]

frameio/types/update_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
+
+UpdateDateDefinitionParamsFieldConfigurationTimeFormat = typing.Union[
+    typing.Literal["twelve_hour", "twenty_four_hour"], typing.Any
+]

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

frameio/types/update_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 .update_number_definition_params_field_configuration import UpdateNumberDefinitionParamsFieldConfiguration
+
+
+class UpdateNumberDefinitionParams(UniversalBaseModel):
+    field_configuration: typing.Optional[UpdateNumberDefinitionParamsFieldConfiguration] = None
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Field definition name
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/update_number_definition_params_field_configuration.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .update_number_definition_params_field_configuration_number_format import (
+    UpdateNumberDefinitionParamsFieldConfigurationNumberFormat,
+)
+
+
+class UpdateNumberDefinitionParamsFieldConfiguration(UniversalBaseModel):
+    number_format: typing.Optional[UpdateNumberDefinitionParamsFieldConfigurationNumberFormat] = pydantic.Field(
+        default=None
+    )
+    """
+    Number format
+    """
+
+    scale: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    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/update_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
+
+UpdateNumberDefinitionParamsFieldConfigurationNumberFormat = typing.Union[
+    typing.Literal["bitrate", "bits", "duration", "framerate", "frequency", "storage", "timecode"], typing.Any
+]

frameio/types/update_rating_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 .update_rating_definition_params_field_configuration import UpdateRatingDefinitionParamsFieldConfiguration
+
+
+class UpdateRatingDefinitionParams(UniversalBaseModel):
+    field_configuration: typing.Optional[UpdateRatingDefinitionParamsFieldConfiguration] = None
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Field definition name
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/update_rating_definition_params_field_configuration.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .update_rating_definition_params_field_configuration_style import (
+    UpdateRatingDefinitionParamsFieldConfigurationStyle,
+)
+
+
+class UpdateRatingDefinitionParamsFieldConfiguration(UniversalBaseModel):
+    color: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Color value hex code for the `style` icon symbols. ex: #fbd400
+    """
+
+    max_value: typing.Optional[int] = None
+    style: typing.Optional[UpdateRatingDefinitionParamsFieldConfigurationStyle] = pydantic.Field(default=None)
+    """
+    Field type
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/update_rating_definition_params_field_configuration_style.py

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

frameio/types/update_select_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 .update_select_definition_params_field_configuration import UpdateSelectDefinitionParamsFieldConfiguration
+
+
+class UpdateSelectDefinitionParams(UniversalBaseModel):
+    field_configuration: typing.Optional[UpdateSelectDefinitionParamsFieldConfiguration] = None
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Field definition name
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2