frameio 0.0.28__py3-none-any.whl

frameio/types/account.py

@@ -0,0 +1,70 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .account_roles_item import AccountRolesItem
+
+
+class Account(UncheckedBaseModel):
+    """
+    Account details
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Created Timestamp
+    """
+
+    display_name: str = pydantic.Field()
+    """
+    Account Name
+    """
+
+    id: str = pydantic.Field()
+    """
+    Account ID
+    """
+
+    image: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The account image url
+    """
+
+    mounted_storage_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether mounted storage is enabled for this account
+    """
+
+    roles: typing.List[AccountRolesItem] = pydantic.Field()
+    """
+    Account User Roles
+    """
+
+    storage_limit: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The number of bytes of non-archived storage in the account. Value is nil when there is no limit
+    """
+
+    storage_usage: int = pydantic.Field()
+    """
+    The number of bytes of non-archived storage the account is using
+    """
+
+    updated_at: dt.datetime = pydantic.Field()
+    """
+    Update timestamp
+    """
+
+    v_4_migrated_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime], FieldMetadata(alias="v4_migrated_at")
+    ] = pydantic.Field(alias="v4_migrated_at", default=None)
+    """
+    Migration timestamp
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/account_roles_item.py

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

frameio/types/account_user_role.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 .account_user_role_role import AccountUserRoleRole
+from .user import User
+
+
+class AccountUserRole(UncheckedBaseModel):
+    """
+    Frame.io Account User Role
+    """
+
+    role: typing.Optional[AccountUserRoleRole] = pydantic.Field(default=None)
+    """
+    Account User Role
+    """
+
+    user: User
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/account_user_role_role.py

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

frameio/types/account_user_roles_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 .account_user_role import AccountUserRole
+from .links import Links
+
+
+class AccountUserRolesResponse(UncheckedBaseModel):
+    """
+    Frame.io Account user role details
+    """
+
+    data: typing.List[AccountUserRole] = pydantic.Field()
+    """
+    Account User Roles
+    """
+
+    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/accounts_response.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 .account import Account
+from .links import Links
+
+
+class AccountsResponse(UncheckedBaseModel):
+    data: typing.List[Account] = pydantic.Field()
+    """
+    Accounts
+    """
+
+    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/add_asset_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 .add_asset_response_data import AddAssetResponseData
+
+
+class AddAssetResponse(UncheckedBaseModel):
+    data: AddAssetResponseData
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/add_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 AddAssetResponseData(Share):
+    asset_added: str = pydantic.Field()
+    """
+    ID for asset added
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/asset_common.py

@@ -0,0 +1,48 @@
+# 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
+
+
+class AssetCommon(UncheckedBaseModel):
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Creation timestamp
+    """
+
+    id: str = pydantic.Field()
+    """
+    File, Folder, or Version Stack ID
+    """
+
+    name: str = pydantic.Field()
+    """
+    File or folder Name
+    """
+
+    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)

frameio/types/asset_common_type.py

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

frameio/types/asset_common_with_includes.py

@@ -0,0 +1,58 @@
+# 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_with_includes_type import AssetCommonWithIncludesType
+from .metadata_field import MetadataField
+from .project_with_includes import ProjectWithIncludes
+from .user import User
+
+
+class AssetCommonWithIncludes(UncheckedBaseModel):
+    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
+    """
+
+    parent_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Parent Folder or Version Stack ID
+    """
+
+    project: typing.Optional[ProjectWithIncludes] = None
+    project_id: str = pydantic.Field()
+    """
+    Project ID
+    """
+
+    type: AssetCommonWithIncludesType
+    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)

frameio/types/asset_common_with_includes_type.py

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

frameio/types/asset_include.py

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

frameio/types/asset_share_params.py

@@ -0,0 +1,39 @@
+# 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_share_params_access import AssetShareParamsAccess
+
+
+class AssetShareParams(UncheckedBaseModel):
+    access: AssetShareParamsAccess
+    asset_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Asset IDs (File, folder, and/or version stack IDs)
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Share description - NOTE: Requires feature custom_branded_shares
+    """
+
+    downloading_enabled: typing.Optional[bool] = None
+    expiration: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Expiration timestamp
+    """
+
+    name: str = pydantic.Field()
+    """
+    Share Name (must include at least one non-whitespace character and no line breaks)
+    """
+
+    passphrase: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Passphrase to access share, if passphrase is required and not given it will be generated
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/asset_share_params_access.py

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

frameio/types/asset_with_includes.py

@@ -0,0 +1,76 @@
+# 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 .file_with_includes import FileWithIncludes
+from .file_with_includes_status import FileWithIncludesStatus
+from .media_links_collection import MediaLinksCollection
+from .metadata_field import MetadataField
+from .project_with_includes import ProjectWithIncludes
+from .user import User
+
+
+class AssetWithIncludes_File(UncheckedBaseModel):
+    type: typing.Literal["file"] = "file"
+    file_size: int
+    media_links: typing.Optional[MediaLinksCollection] = None
+    media_type: str
+    status: FileWithIncludesStatus
+    created_at: dt.datetime
+    creator: typing.Optional[User] = None
+    id: str
+    metadata: typing.Optional[typing.List[MetadataField]] = None
+    name: str
+    parent_id: typing.Optional[str] = None
+    project: typing.Optional[ProjectWithIncludes] = None
+    project_id: str
+    updated_at: dt.datetime
+    view_url: str
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class AssetWithIncludes_Folder(UncheckedBaseModel):
+    type: typing.Literal["folder"] = "folder"
+    cover_file_id: typing.Optional[str] = None
+    parent_id: typing.Optional[str] = None
+    created_at: dt.datetime
+    creator: typing.Optional[User] = None
+    id: str
+    metadata: typing.Optional[typing.List[MetadataField]] = None
+    name: str
+    project: typing.Optional[ProjectWithIncludes] = None
+    project_id: str
+    updated_at: dt.datetime
+    view_url: str
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+class AssetWithIncludes_VersionStack(UncheckedBaseModel):
+    type: typing.Literal["version_stack"] = "version_stack"
+    head_version: FileWithIncludes
+    parent_id: typing.Optional[str] = None
+    created_at: dt.datetime
+    creator: typing.Optional[User] = None
+    id: str
+    metadata: typing.Optional[typing.List[MetadataField]] = None
+    name: str
+    project: typing.Optional[ProjectWithIncludes] = None
+    project_id: str
+    updated_at: dt.datetime
+    view_url: str
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)
+
+
+AssetWithIncludes = typing_extensions.Annotated[
+    typing.Union[AssetWithIncludes_File, AssetWithIncludes_Folder, AssetWithIncludes_VersionStack],
+    UnionMetadata(discriminant="type"),
+]

frameio/types/assets_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.unchecked_base_model import UncheckedBaseModel
+from .asset_with_includes import AssetWithIncludes
+from .links import Links
+
+
+class AssetsWithIncludesResponse(UncheckedBaseModel):
+    data: typing.List[AssetWithIncludes] = pydantic.Field()
+    """
+    Assets
+    """
+
+    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/bad_request.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 .bad_request_errors_item import BadRequestErrorsItem
+
+
+class BadRequest(UncheckedBaseModel):
+    errors: typing.List[BadRequestErrorsItem]
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/bad_request_errors_item.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .bad_request_errors_item_source import BadRequestErrorsItemSource
+
+
+class BadRequestErrorsItem(UncheckedBaseModel):
+    detail: str
+    source: typing.Optional[BadRequestErrorsItemSource] = None
+    title: typing.Optional[str] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/bad_request_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.unchecked_base_model import UncheckedBaseModel
+
+
+class BadRequestErrorsItemSource(UncheckedBaseModel):
+    pointer: typing.Optional[str] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

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

frameio/types/children_type.py

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

frameio/types/comment.py

@@ -0,0 +1,59 @@
+# 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 .time_stamp import TimeStamp
+
+
+class Comment(UncheckedBaseModel):
+    annotation: typing.Optional[str] = None
+    completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Completion timestamp
+    """
+
+    completer_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    ID of user who marked the comment as completed
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Creation timestamp
+    """
+
+    file_id: str = pydantic.Field()
+    """
+    File ID
+    """
+
+    id: str = pydantic.Field()
+    """
+    Comment ID
+    """
+
+    page: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Document page
+    """
+
+    text: str = pydantic.Field()
+    """
+    Comment text
+    """
+
+    text_edited_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Text edited timestamp
+    """
+
+    timestamp: TimeStamp
+    updated_at: dt.datetime = pydantic.Field()
+    """
+    Update timestamp
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/comment_include.py

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

frameio/types/comment_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 .comment import Comment
+
+
+class CommentResponse(UncheckedBaseModel):
+    data: Comment
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/comment_with_includes.py

@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from .comment import Comment
+from .user import User
+
+
+class CommentWithIncludes(Comment):
+    owner: typing.Optional[User] = None
+    replies: typing.Optional[typing.List[Comment]] = pydantic.Field(default=None)
+    """
+    Replies
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/comment_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.unchecked_base_model import UncheckedBaseModel
+from .comment_with_includes import CommentWithIncludes
+
+
+class CommentWithIncludesResponse(UncheckedBaseModel):
+    data: CommentWithIncludes
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)

frameio/types/comments_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.unchecked_base_model import UncheckedBaseModel
+from .comment_with_includes import CommentWithIncludes
+from .links import Links
+
+
+class CommentsWithIncludesResponse(UncheckedBaseModel):
+    data: typing.List[CommentWithIncludes] = pydantic.Field()
+    """
+    Comments
+    """
+
+    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)