frameio 0.0.23__py3-none-any.whl

frameio/types/user_multi_definition_params_field_configuration_member_options_type.py

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

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

frameio/types/user_role.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import UniversalBaseModel
+from .user import User
+from .user_role_role import UserRoleRole
+
+
+class UserRole(UniversalBaseModel):
+    """
+    Frame.io User Role
+    """
+
+    role: UserRoleRole
+    user: User
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/user_role_role.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+UserRoleRole = typing.Union[
+    typing.Literal["full_access", "editor", "edit_only", "commenter", "viewer", "admin", "owner"], typing.Any
+]

frameio/types/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.pydantic_utilities import UniversalBaseModel
+from .links import Links
+from .user_role import UserRole
+
+
+class UserRolesResponse(UniversalBaseModel):
+    """
+    Frame.io user role details
+    """
+
+    data: typing.List[UserRole] = pydantic.Field()
+    """
+    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)  # type: ignore # Pydantic v2

frameio/types/user_single_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 .user_single_definition_field_configuration import UserSingleDefinitionFieldConfiguration
+
+
+class UserSingleDefinition(UniversalBaseModel):
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Created Timestamp
+    """
+
+    creator_id: str = pydantic.Field()
+    """
+    Field definition creator ID
+    """
+
+    field_configuration: UserSingleDefinitionFieldConfiguration
+    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/user_single_definition_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 .user_single_definition_field_configuration_custom_members_item import (
+    UserSingleDefinitionFieldConfigurationCustomMembersItem,
+)
+from .user_single_definition_field_configuration_member_options_type import (
+    UserSingleDefinitionFieldConfigurationMemberOptionsType,
+)
+
+
+class UserSingleDefinitionFieldConfiguration(UniversalBaseModel):
+    custom_members: typing.List[UserSingleDefinitionFieldConfigurationCustomMembersItem]
+    member_options_type: UserSingleDefinitionFieldConfigurationMemberOptionsType
+    notify_members: bool = pydantic.Field()
+    """
+    
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/user_single_definition_field_configuration_custom_members_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
+from .user_single_definition_field_configuration_custom_members_item_type import (
+    UserSingleDefinitionFieldConfigurationCustomMembersItemType,
+)
+
+
+class UserSingleDefinitionFieldConfigurationCustomMembersItem(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    User Id
+    """
+
+    type: UserSingleDefinitionFieldConfigurationCustomMembersItemType
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/user_single_definition_field_configuration_custom_members_item_type.py

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

frameio/types/user_single_definition_field_configuration_member_options_type.py

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

frameio/types/user_single_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 .user_single_definition_params_field_configuration import UserSingleDefinitionParamsFieldConfiguration
+
+
+class UserSingleDefinitionParams(UniversalBaseModel):
+    field_configuration: UserSingleDefinitionParamsFieldConfiguration
+    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/user_single_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 .user_single_definition_params_field_configuration_custom_members_item import (
+    UserSingleDefinitionParamsFieldConfigurationCustomMembersItem,
+)
+from .user_single_definition_params_field_configuration_member_options_type import (
+    UserSingleDefinitionParamsFieldConfigurationMemberOptionsType,
+)
+
+
+class UserSingleDefinitionParamsFieldConfiguration(UniversalBaseModel):
+    custom_members: typing.Optional[typing.List[UserSingleDefinitionParamsFieldConfigurationCustomMembersItem]] = None
+    member_options_type: UserSingleDefinitionParamsFieldConfigurationMemberOptionsType
+    notify_members: bool = pydantic.Field()
+    """
+    
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/user_single_definition_params_field_configuration_custom_members_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
+from .user_single_definition_params_field_configuration_custom_members_item_type import (
+    UserSingleDefinitionParamsFieldConfigurationCustomMembersItemType,
+)
+
+
+class UserSingleDefinitionParamsFieldConfigurationCustomMembersItem(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    User Id
+    """
+
+    type: UserSingleDefinitionParamsFieldConfigurationCustomMembersItemType
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/user_single_definition_params_field_configuration_custom_members_item_type.py

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

frameio/types/user_single_definition_params_field_configuration_member_options_type.py

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

frameio/types/user_single_definition_with_includes.py

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

frameio/types/user_value.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 .user_value_type import UserValueType
+
+
+class UserValue(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    User Id or Account User Group Id
+    """
+
+    type: UserValueType
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/user_value_type.py

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

frameio/types/uuid_.py

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

frameio/types/version_stack.py

@@ -0,0 +1,50 @@
+# 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 .asset_common_type import AssetCommonType
+from .file import File
+
+
+class VersionStack(UniversalBaseModel):
+    head_version: File
+    parent_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Parent Folder ID
+    """
+
+    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
+    """
+
+    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)  # type: ignore # Pydantic v2

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

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

frameio/types/version_stack_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.pydantic_utilities import UniversalBaseModel
+from .file_with_includes import FileWithIncludes
+from .metadata_field import MetadataField
+from .project_with_includes import ProjectWithIncludes
+from .user import User
+
+
+class VersionStackWithIncludes(UniversalBaseModel):
+    head_version: FileWithIncludes
+    parent_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Parent Folder ID
+    """
+
+    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
+    """
+
+    project: typing.Optional[ProjectWithIncludes] = None
+    project_id: str = pydantic.Field()
+    """
+    Project ID
+    """
+
+    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)  # type: ignore # Pydantic v2

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

frameio/types/version_stacks_with_includes_response.py

@@ -0,0 +1,19 @@
+# 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 .version_stack_with_includes import VersionStackWithIncludes
+
+
+class VersionStacksWithIncludesResponse(UniversalBaseModel):
+    data: typing.List[VersionStackWithIncludes]
+    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/webhook.py

@@ -0,0 +1,36 @@
+# 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 .webhook_events import WebhookEvents
+
+
+class Webhook(UniversalBaseModel):
+    active: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Webhook active status
+    """
+
+    created_at: dt.datetime
+    events: WebhookEvents
+    id: str = pydantic.Field()
+    """
+    Webhook ID
+    """
+
+    name: str = pydantic.Field()
+    """
+    Webhook Name
+    """
+
+    updated_at: dt.datetime
+    url: str
+    workspace_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Workspace ID
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/webhook_create_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 .webhook_create_response_data import WebhookCreateResponseData
+
+
+class WebhookCreateResponse(UniversalBaseModel):
+    """
+    Returns a single webhook with secret.
+    """
+
+    data: WebhookCreateResponseData
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/webhook_create_response_data.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from .webhook import Webhook
+
+
+class WebhookCreateResponseData(Webhook):
+    secret: str = pydantic.Field()
+    """
+    Secret used to validate webhook requests. Make sure to store your secret. You won’t be able to see it again!
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/types/webhook_events.py

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

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

frameio/types/webhook_with_includes.py

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

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

frameio/types/webhooks_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.pydantic_utilities import UniversalBaseModel
+from .links import Links
+from .webhook_with_includes import WebhookWithIncludes
+
+
+class WebhooksWithIncludesResponse(UniversalBaseModel):
+    """
+    Frame.io webhooks
+    """
+
+    data: typing.List[WebhookWithIncludes]
+    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