Features providing Policy Set API Specs (#45)

Author: isivaselvan

examples/policy_set.py

@@ -12,6 +12,7 @@
 from .resources.plan import Plans
 from .resources.policy import Policies
 from .resources.policy_check import PolicyChecks
+from .resources.policy_set import PolicySets
 from .resources.projects import Projects
 from .resources.query_run import QueryRuns
 from .resources.registry_module import RegistryModules
@@ -76,6 +77,7 @@ def __init__(self, config: TFEConfig | None = None):
         self.run_events = RunEvents(self._transport)
         self.policies = Policies(self._transport)
         self.policy_checks = PolicyChecks(self._transport)
+        self.policy_sets = PolicySets(self._transport)
 
         # SSH Keys
         self.ssh_keys = SSHKeys(self._transport)

src/pytfe/client.py

@@ -423,3 +423,25 @@ class InvalidPolicyCheckIDError(InvalidValues):
 
     def __init__(self, message: str = "invalid value for policy check ID"):
         super().__init__(message)
+
+
+# Policy Set errors
+class InvalidPolicySetIDError(InvalidValues):
+    """Raised when an invalid policy set ID is provided."""
+
+    def __init__(self, message: str = "invalid value for policy set ID"):
+        super().__init__(message)
+
+
+class RequiredPoliciesError(RequiredFieldMissing):
+    """Raised when a required policies field is missing."""
+
+    def __init__(self, message: str = "policies are required"):
+        super().__init__(message)
+
+
+class InvalidPoliciesError(InvalidValues):
+    """Raised when an invalid policies field is provided."""
+
+    def __init__(self, message: str = "must provide at least one policy"):
+        super().__init__(message)

src/pytfe/errors.py

@@ -19,6 +19,11 @@
     AgentTokenListOptions,
 )
 
+# ──Apply / Plans ──────────────────────────────────────────────────────────────
+from .apply import (
+    Apply,
+)
+
 # ── Core models split out of old types.py ─────────────────────────────────────
 # Adjust these imports to match where you placed them during the split.
 # Common / pagination / enums
@@ -86,6 +91,51 @@
     ReadRunQueueOptions,
     RunQueue,
 )
+from .plan import (
+    Plan,
+)
+from .policy import (
+    Policy,
+    PolicyCreateOptions,
+    PolicyList,
+    PolicyListOptions,
+    PolicyUpdateOptions,
+)
+
+# ── Policy ─────────────────────────────────────────────────────────────
+from .policy_check import (
+    PolicyActions,
+    PolicyCheck,
+    PolicyCheckIncludeOpt,
+    PolicyCheckList,
+    PolicyCheckListOptions,
+    PolicyPermissions,
+    PolicyResult,
+    PolicyScope,
+    PolicyStatus,
+    PolicyStatusTimestamps,
+)
+from .policy_set import (
+    PolicySet,
+    PolicySetAddPoliciesOptions,
+    PolicySetAddProjectsOptions,
+    PolicySetAddWorkspaceExclusionsOptions,
+    PolicySetAddWorkspacesOptions,
+    PolicySetCreateOptions,
+    PolicySetIncludeOpt,
+    PolicySetList,
+    PolicySetListOptions,
+    PolicySetReadOptions,
+    PolicySetRemovePoliciesOptions,
+    PolicySetRemoveProjectsOptions,
+    PolicySetRemoveWorkspaceExclusionsOptions,
+    PolicySetRemoveWorkspacesOptions,
+    PolicySetUpdateOptions,
+)
+from .policy_types import (
+    EnforcementLevel,
+    PolicyKind,
+)
 from .project import Project
 
 # ── Query Runs ────────────────────────────────────────────────────────────────
@@ -158,8 +208,55 @@
 
 # Runs
 from .run import (
+    OrganizationRunList,
     Run,
+    RunActions,
+    RunApplyOptions,
+    RunCancelOptions,
+    RunCreateOptions,
+    RunDiscardOptions,
+    RunForceCancelOptions,
+    RunIncludeOpt,
+    RunList,
+    RunListForOrganizationOptions,
+    RunListOptions,
+    RunOperation,
+    RunPermissions,
+    RunReadOptions,
+    RunSource,
     RunStatus,
+    RunStatusTimestamps,
+    RunVariable,
+    RunVariableAttr,
+)
+from .run_event import (
+    RunEvent,
+    RunEventIncludeOpt,
+    RunEventList,
+    RunEventListOptions,
+    RunEventReadOptions,
+)
+from .run_task import (
+    GlobalRunTask,
+    GlobalRunTaskOptions,
+    RunTask,
+    RunTaskCreateOptions,
+    RunTaskIncludeOptions,
+    RunTaskList,
+    RunTaskListOptions,
+    RunTaskReadOptions,
+    RunTaskUpdateOptions,
+    Stage,
+    TaskEnforcementLevel,
+)
+from .run_trigger import (
+    RunTrigger,
+    RunTriggerCreateOptions,
+    RunTriggerFilterOp,
+    RunTriggerIncludeOp,
+    RunTriggerList,
+    RunTriggerListOptions,
+    SourceableChoice,
 )
 
 # ── SSH Keys ──────────────────────────────────────────────────────────────────
@@ -183,6 +280,7 @@
 from .workspace import (
     LockedByChoice,
     VCSRepo,
+    VCSRepoOptions,
     Workspace,
     WorkspaceActions,
     WorkspaceAddRemoteStateConsumersOptions,
@@ -341,6 +439,7 @@
     "VariableUpdateOptions",
     "LockedByChoice",
     "VCSRepo",
+    "VCSRepoOptions",
     "Workspace",
     "WorkspaceActions",
     "WorkspaceAddRemoteStateConsumersOptions",
@@ -364,8 +463,91 @@
     "WorkspaceTagListOptions",
     "WorkspaceUpdateOptions",
     "WorkspaceUpdateRemoteStateConsumersOptions",
-    "Run",
     "RunQueue",
-    "RunStatus",
     "ReadRunQueueOptions",
+    # Apply & Plans
+    "Apply",
+    "Plan",
+    # Runs
+    "Run",
+    "RunStatus",
+    "RunSource",
+    "RunIncludeOpt",
+    "RunOperation",
+    "RunActions",
+    "RunPermissions",
+    "RunStatusTimestamps",
+    "RunVariable",
+    "RunVariableAttr",
+    "RunList",
+    "RunListOptions",
+    "OrganizationRunList",
+    "RunListForOrganizationOptions",
+    "RunCreateOptions",
+    "RunReadOptions",
+    "RunApplyOptions",
+    "RunCancelOptions",
+    "RunForceCancelOptions",
+    "RunDiscardOptions",
+    # Run events
+    "RunEvent",
+    "RunEventIncludeOpt",
+    "RunEventList",
+    "RunEventListOptions",
+    "RunEventReadOptions",
+    # Run tasks
+    "RunTask",
+    "RunTaskIncludeOptions",
+    "GlobalRunTask",
+    "GlobalRunTaskOptions",
+    "Stage",
+    "TaskEnforcementLevel",
+    "RunTaskList",
+    "RunTaskListOptions",
+    "RunTaskCreateOptions",
+    "RunTaskUpdateOptions",
+    "RunTaskReadOptions",
+    # Run triggers
+    "RunTrigger",
+    "RunTriggerCreateOptions",
+    "RunTriggerList",
+    "RunTriggerListOptions",
+    "SourceableChoice",
+    "RunTriggerFilterOp",
+    "RunTriggerIncludeOp",
+    # Policy Checks
+    "PolicyCheck",
+    "PolicyCheckIncludeOpt",
+    "PolicyScope",
+    "PolicyStatus",
+    "PolicyActions",
+    "PolicyPermissions",
+    "PolicyResult",
+    "PolicyStatusTimestamps",
+    "PolicyCheckListOptions",
+    "PolicyCheckList",
+    # Policy
+    "Policy",
+    "PolicyCreateOptions",
+    "PolicyList",
+    "PolicyListOptions",
+    "PolicyUpdateOptions",
+    # Policy Sets
+    "PolicySet",
+    "PolicySetIncludeOpt",
+    "PolicySetList",
+    "PolicySetAddPoliciesOptions",
+    "PolicySetAddProjectsOptions",
+    "PolicySetAddWorkspacesOptions",
+    "PolicySetAddWorkspaceExclusionsOptions",
+    "PolicySetCreateOptions",
+    "PolicySetListOptions",
+    "PolicySetReadOptions",
+    "PolicySetRemovePoliciesOptions",
+    "PolicySetRemoveWorkspacesOptions",
+    "PolicySetRemoveWorkspaceExclusionsOptions",
+    "PolicySetRemoveProjectsOptions",
+    "PolicySetUpdateOptions",
+    "PolicyKind",
+    "EnforcementLevel",
 ]

src/pytfe/models/__init__.py

@@ -1,19 +1,11 @@
 from __future__ import annotations
 
 from datetime import datetime
-from enum import Enum
 
 from pydantic import BaseModel, ConfigDict, Field
 
 from .organization import Organization
-from .policy_set import PolicyKind
-
-
-class EnforcementLevel(str, Enum):
-    ENFORCEMENT_ADVISORY = "advisory"
-    ENFORCEMENT_MANDATORY = "mandatory"
-    ENFORCEMENT_HARD = "hard-mandatory"
-    ENFORCEMENT_SOFT = "soft-mandatory"
+from .policy_types import EnforcementLevel, PolicyKind
 
 
 class Policy(BaseModel):