zenml-nightly 0.75.0.dev20250313__py3-none-any.whl → 0.75.0.dev20250314__py3-none-any.whl

zenml/models/v2/core/project.py

@@ -0,0 +1,203 @@
+#  Copyright (c) ZenML GmbH 2023. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at:
+#
+#       https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+#  or implied. See the License for the specific language governing
+#  permissions and limitations under the License.
+"""Models representing projects."""
+
+import re
+from typing import Any, Dict, Optional
+
+from pydantic import Field, model_validator
+
+from zenml.constants import STR_FIELD_MAX_LENGTH, STR_ID_FIELD_MAX_LENGTH
+from zenml.models.v2.base.base import (
+    BaseDatedResponseBody,
+    BaseIdentifiedResponse,
+    BaseRequest,
+    BaseResponseMetadata,
+    BaseResponseResources,
+    BaseUpdate,
+)
+from zenml.models.v2.base.filter import BaseFilter
+from zenml.utils.pydantic_utils import before_validator_handler
+
+# ------------------ Request Model ------------------
+
+
+class ProjectRequest(BaseRequest):
+    """Request model for projects."""
+
+    name: str = Field(
+        title="The unique name of the project. The project name must only "
+        "contain only lowercase letters, numbers, underscores, and hyphens and "
+        "be at most 50 characters long.",
+        min_length=1,
+        max_length=STR_ID_FIELD_MAX_LENGTH,
+        pattern=r"^[a-z0-9_-]+$",
+    )
+    display_name: str = Field(
+        default="",
+        title="The display name of the project.",
+        max_length=STR_FIELD_MAX_LENGTH,
+    )
+    description: str = Field(
+        default="",
+        title="The description of the project.",
+        max_length=STR_FIELD_MAX_LENGTH,
+    )
+
+    @model_validator(mode="before")
+    @classmethod
+    @before_validator_handler
+    def _validate_project_name(cls, data: Dict[str, Any]) -> Dict[str, Any]:
+        """Validate the project name.
+
+        Args:
+            data: The values to validate.
+
+        Returns:
+            The validated values.
+        """
+        name = data.get("name")
+        display_name = data.get("display_name")
+
+        if not name and not display_name:
+            return data
+
+        if not name:
+            assert display_name
+
+            project_name = display_name.lower().replace(" ", "-")
+            project_name = re.sub(r"[^a-z0-9_-]", "", project_name)
+
+            data["name"] = project_name
+
+        if not display_name:
+            # We just use the name as the display name
+            data["display_name"] = name
+
+        return data
+
+
+# ------------------ Update Model ------------------
+
+
+class ProjectUpdate(BaseUpdate):
+    """Update model for projects."""
+
+    name: Optional[str] = Field(
+        title="The unique name of the project. The project name must only "
+        "contain only lowercase letters, numbers, underscores, and hyphens and "
+        "be at most 50 characters long.",
+        min_length=1,
+        max_length=STR_ID_FIELD_MAX_LENGTH,
+        pattern=r"^[a-z0-9_-]+$",
+        default=None,
+    )
+    display_name: Optional[str] = Field(
+        title="The display name of the project.",
+        max_length=STR_FIELD_MAX_LENGTH,
+        default=None,
+    )
+    description: Optional[str] = Field(
+        title="The description of the project.",
+        max_length=STR_FIELD_MAX_LENGTH,
+        default=None,
+    )
+
+
+# ------------------ Response Model ------------------
+
+
+class ProjectResponseBody(BaseDatedResponseBody):
+    """Response body for projects."""
+
+    display_name: str = Field(
+        title="The display name of the project.",
+        max_length=STR_FIELD_MAX_LENGTH,
+    )
+
+
+class ProjectResponseMetadata(BaseResponseMetadata):
+    """Response metadata for projects."""
+
+    description: str = Field(
+        default="",
+        title="The description of the project.",
+        max_length=STR_FIELD_MAX_LENGTH,
+    )
+
+
+class ProjectResponseResources(BaseResponseResources):
+    """Class for all resource models associated with the project entity."""
+
+
+class ProjectResponse(
+    BaseIdentifiedResponse[
+        ProjectResponseBody,
+        ProjectResponseMetadata,
+        ProjectResponseResources,
+    ]
+):
+    """Response model for projects."""
+
+    name: str = Field(
+        title="The unique name of the project.",
+        max_length=STR_ID_FIELD_MAX_LENGTH,
+    )
+
+    def get_hydrated_version(self) -> "ProjectResponse":
+        """Get the hydrated version of this project.
+
+        Returns:
+            an instance of the same entity with the metadata field attached.
+        """
+        from zenml.client import Client
+
+        return Client().zen_store.get_project(self.id)
+
+    # Body and metadata properties
+
+    @property
+    def display_name(self) -> str:
+        """The `display_name` property.
+
+        Returns:
+            the value of the property.
+        """
+        return self.get_body().display_name
+
+    @property
+    def description(self) -> str:
+        """The `description` property.
+
+        Returns:
+            the value of the property.
+        """
+        return self.get_metadata().description
+
+
+# ------------------ Filter Model ------------------
+
+
+class ProjectFilter(BaseFilter):
+    """Model to enable advanced filtering of all projects."""
+
+    name: Optional[str] = Field(
+        default=None,
+        description="Name of the project",
+    )
+
+    display_name: Optional[str] = Field(
+        default=None,
+        description="Display name of the project",
+    )

zenml/models/v2/core/run_metadata.py

@@ -20,14 +20,14 @@ from pydantic import Field, model_validator
 
 from zenml.metadata.metadata_types import MetadataType, MetadataTypeEnum
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedRequest,
+    ProjectScopedRequest,
 )
 from zenml.models.v2.misc.run_metadata import RunMetadataResource
 
 # ------------------ Request Model ------------------
 
 
-class RunMetadataRequest(WorkspaceScopedRequest):
+class RunMetadataRequest(ProjectScopedRequest):
     """Request model for run metadata."""
 
     resources: List[RunMetadataResource] = Field(

zenml/models/v2/core/run_template.py

@@ -33,13 +33,13 @@ from zenml.constants import STR_FIELD_MAX_LENGTH, TEXT_FIELD_MAX_LENGTH
 from zenml.enums import ExecutionStatus
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
     TaggableFilter,
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
 )
 from zenml.models.v2.core.code_reference import (
     CodeReferenceResponse,
@@ -64,7 +64,7 @@ if TYPE_CHECKING:
 # ------------------ Request Model ------------------
 
 
-class RunTemplateRequest(WorkspaceScopedRequest):
+class RunTemplateRequest(ProjectScopedRequest):
     """Request model for run templates."""
 
     name: str = Field(
@@ -112,7 +112,7 @@ class RunTemplateUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class RunTemplateResponseBody(WorkspaceScopedResponseBody):
+class RunTemplateResponseBody(ProjectScopedResponseBody):
     """Response body for run templates."""
 
     runnable: bool = Field(
@@ -128,7 +128,7 @@ class RunTemplateResponseBody(WorkspaceScopedResponseBody):
     )
 
 
-class RunTemplateResponseMetadata(WorkspaceScopedResponseMetadata):
+class RunTemplateResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for run templates."""
 
     description: Optional[str] = Field(
@@ -146,7 +146,7 @@ class RunTemplateResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class RunTemplateResponseResources(WorkspaceScopedResponseResources):
+class RunTemplateResponseResources(ProjectScopedResponseResources):
     """All resource models associated with the run template."""
 
     source_deployment: Optional[PipelineDeploymentResponse] = Field(
@@ -170,7 +170,7 @@ class RunTemplateResponseResources(WorkspaceScopedResponseResources):
 
 
 class RunTemplateResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         RunTemplateResponseBody,
         RunTemplateResponseMetadata,
         RunTemplateResponseResources,
@@ -308,11 +308,11 @@ class RunTemplateResponse(
 # ------------------ Filter Model ------------------
 
 
-class RunTemplateFilter(WorkspaceScopedFilter, TaggableFilter):
+class RunTemplateFilter(ProjectScopedFilter, TaggableFilter):
     """Model for filtering of run templates."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
         *TaggableFilter.FILTER_EXCLUDE_FIELDS,
         "code_repository_id",
         "stack_id",
@@ -322,11 +322,11 @@ class RunTemplateFilter(WorkspaceScopedFilter, TaggableFilter):
         "stack",
     ]
     CUSTOM_SORTING_OPTIONS = [
-        *WorkspaceScopedFilter.CUSTOM_SORTING_OPTIONS,
+        *ProjectScopedFilter.CUSTOM_SORTING_OPTIONS,
         *TaggableFilter.CUSTOM_SORTING_OPTIONS,
     ]
     CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.CLI_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.CLI_EXCLUDE_FIELDS,
         *TaggableFilter.CLI_EXCLUDE_FIELDS,
     ]
 

zenml/models/v2/core/schedule.py

@@ -24,12 +24,12 @@ from zenml.logger import get_logger
 from zenml.metadata.metadata_types import MetadataType
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
 )
 from zenml.utils.time_utils import to_utc_timezone
 
@@ -39,7 +39,7 @@ logger = get_logger(__name__)
 # ------------------ Request Model ------------------
 
 
-class ScheduleRequest(WorkspaceScopedRequest):
+class ScheduleRequest(ProjectScopedRequest):
     """Request model for schedules."""
 
     name: str
@@ -132,7 +132,7 @@ class ScheduleUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class ScheduleResponseBody(WorkspaceScopedResponseBody):
+class ScheduleResponseBody(ProjectScopedResponseBody):
     """Response body for schedules."""
 
     active: bool
@@ -144,7 +144,7 @@ class ScheduleResponseBody(WorkspaceScopedResponseBody):
     run_once_start_time: Optional[datetime] = None
 
 
-class ScheduleResponseMetadata(WorkspaceScopedResponseMetadata):
+class ScheduleResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for schedules."""
 
     orchestrator_id: Optional[UUID]
@@ -156,12 +156,12 @@ class ScheduleResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class ScheduleResponseResources(WorkspaceScopedResponseResources):
+class ScheduleResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the schedule entity."""
 
 
 class ScheduleResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         ScheduleResponseBody,
         ScheduleResponseMetadata,
         ScheduleResponseResources,
@@ -304,7 +304,7 @@ class ScheduleResponse(
 # ------------------ Filter Model ------------------
 
 
-class ScheduleFilter(WorkspaceScopedFilter):
+class ScheduleFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of all Users."""
 
     pipeline_id: Optional[Union[UUID, str]] = Field(

zenml/models/v2/core/secret.py

@@ -162,7 +162,7 @@ class SecretResponse(
     )
 
     def get_hydrated_version(self) -> "SecretResponse":
-        """Get the hydrated version of this workspace.
+        """Get the hydrated version of this secret.
 
         Returns:
             an instance of the same entity with the metadata field attached.

zenml/models/v2/core/service.py

@@ -33,12 +33,12 @@ from sqlalchemy.sql.elements import ColumnElement
 from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
 )
 from zenml.services.service_status import ServiceState
 from zenml.services.service_type import ServiceType
@@ -53,7 +53,7 @@ if TYPE_CHECKING:
 # ------------------ Request Model ------------------
 
 
-class ServiceRequest(WorkspaceScopedRequest):
+class ServiceRequest(ProjectScopedRequest):
     """Request model for services."""
 
     name: str = Field(
@@ -178,7 +178,7 @@ class ServiceUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class ServiceResponseBody(WorkspaceScopedResponseBody):
+class ServiceResponseBody(ProjectScopedResponseBody):
     """Response body for services."""
 
     service_type: ServiceType = Field(
@@ -200,7 +200,7 @@ class ServiceResponseBody(WorkspaceScopedResponseBody):
     )
 
 
-class ServiceResponseMetadata(WorkspaceScopedResponseMetadata):
+class ServiceResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for services."""
 
     service_source: Optional[str] = Field(
@@ -229,7 +229,7 @@ class ServiceResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class ServiceResponseResources(WorkspaceScopedResponseResources):
+class ServiceResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the service entity."""
 
     pipeline_run: Optional["PipelineRunResponse"] = Field(
@@ -251,7 +251,7 @@ class ServiceResponseResources(WorkspaceScopedResponseResources):
 
 
 class ServiceResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         ServiceResponseBody, ServiceResponseMetadata, ServiceResponseResources
     ]
 ):
@@ -404,7 +404,7 @@ class ServiceResponse(
 # ------------------ Filter Model ------------------
 
 
-class ServiceFilter(WorkspaceScopedFilter):
+class ServiceFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of services."""
 
     name: Optional[str] = Field(
@@ -474,7 +474,7 @@ class ServiceFilter(WorkspaceScopedFilter):
 
     # Artifact name and type are not DB fields and need to be handled separately
     FILTER_EXCLUDE_FIELDS = [
-        *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
         "flavor",
         "type",
         "pipeline_step_name",
@@ -483,7 +483,7 @@ class ServiceFilter(WorkspaceScopedFilter):
         "config",
     ]
     CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.CLI_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.CLI_EXCLUDE_FIELDS,
         "flavor",
         "type",
         "pipeline_step_name",

zenml/models/v2/core/step_run.py

@@ -35,12 +35,12 @@ from zenml.enums import ExecutionStatus, StepRunInputArtifactType
 from zenml.metadata.metadata_types import MetadataType
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
 )
 from zenml.models.v2.core.artifact_version import ArtifactVersionResponse
 from zenml.models.v2.core.model_version import ModelVersionResponse
@@ -79,7 +79,7 @@ class StepRunInputResponse(ArtifactVersionResponse):
 # ------------------ Request Model ------------------
 
 
-class StepRunRequest(WorkspaceScopedRequest):
+class StepRunRequest(ProjectScopedRequest):
     """Request model for step runs."""
 
     name: str = Field(
@@ -168,7 +168,7 @@ class StepRunUpdate(BaseUpdate):
 
 
 # ------------------ Response Model ------------------
-class StepRunResponseBody(WorkspaceScopedResponseBody):
+class StepRunResponseBody(ProjectScopedResponseBody):
     """Response body for step runs."""
 
     status: ExecutionStatus = Field(title="The status of the step.")
@@ -196,7 +196,7 @@ class StepRunResponseBody(WorkspaceScopedResponseBody):
     model_config = ConfigDict(protected_namespaces=())
 
 
-class StepRunResponseMetadata(WorkspaceScopedResponseMetadata):
+class StepRunResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for step runs."""
 
     # Configuration
@@ -250,7 +250,7 @@ class StepRunResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class StepRunResponseResources(WorkspaceScopedResponseResources):
+class StepRunResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the step run entity."""
 
     model_version: Optional[ModelVersionResponse] = None
@@ -265,7 +265,7 @@ class StepRunResponseResources(WorkspaceScopedResponseResources):
 
 
 class StepRunResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         StepRunResponseBody, StepRunResponseMetadata, StepRunResponseResources
     ]
 ):
@@ -504,11 +504,11 @@ class StepRunResponse(
 # ------------------ Filter Model ------------------
 
 
-class StepRunFilter(WorkspaceScopedFilter):
+class StepRunFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of step runs."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
         "model",
         "run_metadata",
     ]

zenml/models/v2/core/trigger.py

@@ -33,12 +33,12 @@ from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.page import Page
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
 )
 from zenml.models.v2.core.trigger_execution import TriggerExecutionResponse
 
@@ -57,7 +57,7 @@ if TYPE_CHECKING:
 # ------------------ Request Model ------------------
 
 
-class TriggerRequest(WorkspaceScopedRequest):
+class TriggerRequest(ProjectScopedRequest):
     """Model for creating a new trigger."""
 
     name: str = Field(
@@ -145,7 +145,7 @@ class TriggerUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class TriggerResponseBody(WorkspaceScopedResponseBody):
+class TriggerResponseBody(ProjectScopedResponseBody):
     """Response body for triggers."""
 
     action_flavor: str = Field(
@@ -172,7 +172,7 @@ class TriggerResponseBody(WorkspaceScopedResponseBody):
     )
 
 
-class TriggerResponseMetadata(WorkspaceScopedResponseMetadata):
+class TriggerResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for triggers."""
 
     description: str = Field(
@@ -192,7 +192,7 @@ class TriggerResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class TriggerResponseResources(WorkspaceScopedResponseResources):
+class TriggerResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the trigger entity."""
 
     action: "ActionResponse" = Field(
@@ -209,7 +209,7 @@ class TriggerResponseResources(WorkspaceScopedResponseResources):
 
 
 class TriggerResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         TriggerResponseBody, TriggerResponseMetadata, TriggerResponseResources
     ]
 ):
@@ -324,11 +324,11 @@ class TriggerResponse(
 # ------------------ Filter Model ------------------
 
 
-class TriggerFilter(WorkspaceScopedFilter):
+class TriggerFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of all triggers."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
         "action_flavor",
         "action_subtype",
         "event_source_flavor",

zenml/models/v2/core/trigger_execution.py

@@ -27,7 +27,7 @@ from zenml.models.v2.base.base import (
     BaseDatedResponseBody,
     BaseResponseResources,
 )
-from zenml.models.v2.base.scoped import WorkspaceScopedFilter
+from zenml.models.v2.base.scoped import ProjectScopedFilter
 
 if TYPE_CHECKING:
     from zenml.models.v2.core.trigger import TriggerResponse
@@ -109,7 +109,7 @@ class TriggerExecutionResponse(
 # ------------------ Filter Model ------------------
 
 
-class TriggerExecutionFilter(WorkspaceScopedFilter):
+class TriggerExecutionFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of all trigger executions."""
 
     trigger_id: Optional[Union[UUID, str]] = Field(

zenml/models/v2/core/user.py

@@ -81,10 +81,6 @@ class UserBase(BaseModel):
         default=None,
         title="The metadata associated with the user.",
     )
-    default_workspace_id: Optional[UUID] = Field(
-        default=None,
-        title="The default workspace ID for the user.",
-    )
 
     @classmethod
     def _get_crypt_context(cls) -> "CryptContext":
@@ -283,10 +279,6 @@ class UserResponseBody(BaseDatedResponseBody):
     is_admin: bool = Field(
         title="Whether the account is an administrator.",
     )
-    default_workspace_id: Optional[UUID] = Field(
-        default=None,
-        title="The default workspace ID for the user.",
-    )
 
 
 class UserResponseMetadata(BaseResponseMetadata):
@@ -403,15 +395,6 @@ class UserResponse(
         """
         return self.get_body().is_admin
 
-    @property
-    def default_workspace_id(self) -> Optional[UUID]:
-        """The `default_workspace_id` property.
-
-        Returns:
-            the value of the property.
-        """
-        return self.get_body().default_workspace_id
-
     @property
     def email(self) -> Optional[str]:
         """The `email` property.