frameio 0.0.23__py3-none-any.whl

frameio/types/projects_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.pydantic_utilities import UniversalBaseModel
+from .links import Links
+from .project_with_includes import ProjectWithIncludes
+
+
+class ProjectsWithIncludesResponse(UniversalBaseModel):
+    """
+    Frame.io projects
+    """
+
+    data: typing.List[ProjectWithIncludes] = pydantic.Field()
+    """
+    Projects
+    """
+
+    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/rating_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 .rating_definition_field_configuration import RatingDefinitionFieldConfiguration
+
+
+class RatingDefinition(UniversalBaseModel):
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Created Timestamp
+    """
+
+    creator_id: str = pydantic.Field()
+    """
+    Field definition creator ID
+    """
+
+    field_configuration: RatingDefinitionFieldConfiguration
+    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/rating_definition_field_configuration.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
+from .rating_definition_field_configuration_style import RatingDefinitionFieldConfigurationStyle
+
+
+class RatingDefinitionFieldConfiguration(UniversalBaseModel):
+    color: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Color value hex code for the `style` icon symbols. ex: #fbd400
+    """
+
+    max_value: int
+    style: typing.Optional[RatingDefinitionFieldConfigurationStyle] = pydantic.Field(default=None)
+    """
+    Field type
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/rating_definition_field_configuration_style.py

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

frameio/types/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 .rating_definition_params_field_configuration import RatingDefinitionParamsFieldConfiguration
+
+
+class RatingDefinitionParams(UniversalBaseModel):
+    field_configuration: RatingDefinitionParamsFieldConfiguration
+    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/rating_definition_params_field_configuration.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
+from .rating_definition_params_field_configuration_style import RatingDefinitionParamsFieldConfigurationStyle
+
+
+class RatingDefinitionParamsFieldConfiguration(UniversalBaseModel):
+    color: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Color value hex code for the `style` icon symbols. ex: #fbd400
+    """
+
+    max_value: int
+    style: typing.Optional[RatingDefinitionParamsFieldConfigurationStyle] = pydantic.Field(default=None)
+    """
+    Field type
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/rating_definition_params_field_configuration_style.py

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

frameio/types/rating_definition_with_includes.py

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

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

frameio/types/remove_asset_response_data.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from .share import Share
+
+
+class RemoveAssetResponseData(Share):
+    asset_removed: str = pydantic.Field()
+    """
+    ID for asset added
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/rendition_media_link.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from .media_link_common import MediaLinkCommon
+
+
+class RenditionMediaLink(MediaLinkCommon):
+    url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL to transcoded media that won't include any Content-Disposition header in the response.<br>
+    Watermarks may be applied as per Account settings and User permissions.<br>
+    Media content may be streamed (e.g. when watermarks are required). Clients may issue a
+    HEAD request to determine whether Content-Length and/or Accept-Ranges headers are present in order
+    to determine whether the content can be downloaded in parallel chunks.
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/request_after_opaque_cursor.py

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

frameio/types/request_page_size.py

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

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

@@ -0,0 +1,18 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .select_definition_field_configuration_options_item import SelectDefinitionFieldConfigurationOptionsItem
+
+
+class SelectDefinitionFieldConfiguration(UniversalBaseModel):
+    enable_add_new: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Allow or disallow adding in new option(s) from the grid/list view
+    """
+
+    options: typing.List[SelectDefinitionFieldConfigurationOptionsItem]
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/select_definition_field_configuration_options_item.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 SelectDefinitionFieldConfigurationOptionsItem(UniversalBaseModel):
+    color: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Color value hex code for the `display_name`. ex: #fbd400
+    """
+
+    display_name: str = pydantic.Field()
+    """
+    Option display name
+    """
+
+    id: typing.Optional[str] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/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 .select_definition_params_field_configuration import SelectDefinitionParamsFieldConfiguration
+
+
+class SelectDefinitionParams(UniversalBaseModel):
+    field_configuration: SelectDefinitionParamsFieldConfiguration
+    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/select_definition_params_field_configuration.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .select_definition_params_field_configuration_options_item import (
+    SelectDefinitionParamsFieldConfigurationOptionsItem,
+)
+
+
+class SelectDefinitionParamsFieldConfiguration(UniversalBaseModel):
+    enable_add_new: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Allow or disallow adding in new option(s) from the grid/list view
+    """
+
+    options: typing.List[SelectDefinitionParamsFieldConfigurationOptionsItem]
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/select_definition_params_field_configuration_options_item.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+
+
+class SelectDefinitionParamsFieldConfigurationOptionsItem(UniversalBaseModel):
+    color: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Color value hex code for the `display_name`. ex: #fbd400
+    """
+
+    display_name: str = pydantic.Field()
+    """
+    Option display name
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/select_definition_with_includes.py

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

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

@@ -0,0 +1,18 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .select_multi_definition_field_configuration_options_item import SelectMultiDefinitionFieldConfigurationOptionsItem
+
+
+class SelectMultiDefinitionFieldConfiguration(UniversalBaseModel):
+    enable_add_new: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Allow or disallow adding in new option(s) from the grid/list view
+    """
+
+    options: typing.List[SelectMultiDefinitionFieldConfigurationOptionsItem]
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/select_multi_definition_field_configuration_options_item.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 SelectMultiDefinitionFieldConfigurationOptionsItem(UniversalBaseModel):
+    color: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Color value hex code for the `display_name`. ex: #fbd400
+    """
+
+    display_name: str = pydantic.Field()
+    """
+    Option display name
+    """
+
+    id: typing.Optional[str] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/select_multi_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 .select_multi_definition_params_field_configuration import SelectMultiDefinitionParamsFieldConfiguration
+
+
+class SelectMultiDefinitionParams(UniversalBaseModel):
+    field_configuration: SelectMultiDefinitionParamsFieldConfiguration
+    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/select_multi_definition_params_field_configuration.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .select_multi_definition_params_field_configuration_options_item import (
+    SelectMultiDefinitionParamsFieldConfigurationOptionsItem,
+)
+
+
+class SelectMultiDefinitionParamsFieldConfiguration(UniversalBaseModel):
+    enable_add_new: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Allow or disallow adding in new option(s) from the grid/list view
+    """
+
+    options: typing.List[SelectMultiDefinitionParamsFieldConfigurationOptionsItem]
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/select_multi_definition_params_field_configuration_options_item.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+
+
+class SelectMultiDefinitionParamsFieldConfigurationOptionsItem(UniversalBaseModel):
+    color: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Color value hex code for the `display_name`. ex: #fbd400
+    """
+
+    display_name: str = pydantic.Field()
+    """
+    Option display name
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/select_multi_definition_with_includes.py

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

frameio/types/select_option.py

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

frameio/types/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 SelectValue(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/share.py

@@ -0,0 +1,66 @@
+# 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 .share_access import ShareAccess
+
+
+class Share(UniversalBaseModel):
+    access: ShareAccess
+    collection_id: str = pydantic.Field()
+    """
+    Collection ID
+    """
+
+    commenting_enabled: bool
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Creation timestamp
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Share description
+    """
+
+    downloading_enabled: bool
+    enabled: bool
+    expiration: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Expiration timestamp
+    """
+
+    id: str = pydantic.Field()
+    """
+    Share ID
+    """
+
+    last_viewed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Last viewed timestamp
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Share name
+    """
+
+    passphrase: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Passphrase to access share, if passphrase is required and not given it will be generated
+    """
+
+    short_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Share URL
+    """
+
+    updated_at: dt.datetime = pydantic.Field()
+    """
+    Update timestamp
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/share_access.py

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