harness-platform-sdk 1.0.0__py3-none-any.whl

harness_platform_sdk/__init__.py

@@ -0,0 +1,56 @@
+"""Harness Platform SDK.
+
+A Python SDK for interacting with the Harness Platform API.
+Provides unified access to all Harness APIs (Organizations, Projects,
+Pipelines, Connectors, Secrets, and more) with built-in authentication,
+scope management, pagination, and retry handling.
+"""
+
+from .authz import *
+from .client import HarnessClient
+from .config import HarnessConfig
+from .exceptions import ApiError, AuthError, HarnessSdkError, ScopeNotSetError
+from .iacm_api import *
+from .idp_api import *
+from .ng_api import *
+from .pipeline_api import *
+from .scope import Scope
+from .template_api import *
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "HarnessClient",
+    "HarnessConfig",
+    "Scope",
+    "HarnessSdkError",
+    "ScopeNotSetError",
+    "ApiError",
+    "AuthError",
+    "OrganizationsApi",
+    "ProjectsApi",
+    "ServicesApi",
+    "RolesApi",
+    "ResourceGroupsApi",
+    "RoleAssignmentsApi",
+    "ConnectorsApi",
+    "SecretsApi",
+    "InfrastructuresApi",
+    "UserGroupsApi",
+    "PipelinesV0Api",
+    "InputSetsV0Api",
+    "TriggersV0Api",
+    "TemplatesV0Api",
+    "VariablesApi",
+    "ServiceOverridesApi",
+    # Infrastructure as Code
+    "WorkspacesApi",
+    "WorkspaceApprovalsApi",
+    "WorkspaceDefaultPipelinesApi",
+    "WorkspaceStatesApi",
+    "WorkspaceVariablesApi",
+    # Internal Developer Portal
+    "CatalogCustomPropertyApi",
+    "EntityApi",
+    "ScoreApi",
+]

harness_platform_sdk/authz/__init__.py

@@ -0,0 +1,15 @@
+"""Harness Authorization API resources.
+
+Provides APIs for managing roles, resource groups, and role assignments
+under the /authz/ path root.
+"""
+
+from .resource_groups import ResourceGroupsApi
+from .role_assignments import RoleAssignmentsApi
+from .roles import RolesApi
+
+__all__ = [
+    "RolesApi",
+    "ResourceGroupsApi",
+    "RoleAssignmentsApi",
+]

harness_platform_sdk/authz/resource_groups.py

@@ -0,0 +1,274 @@
+"""ResourceGroups API client for Harness SDK.
+
+Provides CRUD operations for resource_group resources.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Iterator
+
+from harness_platform_sdk.client import HarnessClient
+from harness_platform_sdk.models.authz.resource_groups import (
+    ResourceGroupCreateRequest,
+    ResourceGroupResponse,
+)
+from harness_platform_sdk.pagination import PaginationStyle
+from harness_platform_sdk.scope import Scope
+
+
+class ResourceGroupsApi:
+    """API client for resource_group operations."""
+
+    def __init__(self, client: HarnessClient) -> None:
+        """Initialize ResourceGroupsApi with HarnessClient.
+
+        Args:
+            client: HarnessClient instance for making requests.
+        """
+        self._client = client
+
+    @property
+    def root_api_path(self) -> str:
+        """Get the root API path for resource group endpoints.
+
+        Returns:
+            str: The base API path for resource group operations.
+        """
+        return "/authz/api/v2/resourcegroup"
+
+    @property
+    def unwrap_key(self) -> str:
+        """Get the response unwrap key for resource group data.
+
+        Returns:
+            str: The key used to extract resource group data from API responses.
+        """
+        return "resourceGroup"
+
+    @property
+    def should_wrap(self) -> bool:
+        """Check if request bodies should be wrapped.
+
+        Returns:
+            bool: True if request bodies need to be wrapped before sending to API.
+        """
+        return True
+
+    @property
+    def default_params(self):
+        """Get the Default Request Parameters configuration."""
+        return getattr(self, "_default_params", None)
+
+    @default_params.setter
+    def default_params(self, resolved: Scope) -> dict:
+        """Resolve Scope Variables and Set Default Params.
+
+        Args:
+            resolved: Scope containing account/org/project context.
+            scope: Call-time scope (takes precedence).
+
+        Returns:
+            Dictionary of Parsed Querystrings from the scope
+
+        Raises:
+            ScopeNotSetError: If required fields are missing.
+        """
+        self._default_params = self._client._build_url(
+            "&".join(
+                [
+                    "accountIdentifier={account_id}",
+                    "orgIdentifier={org}",
+                    "projectIdentifier={project}",
+                ]
+            ),
+            resolved,
+            is_params=True,
+        )
+
+    @property
+    def resolved_scope(self):
+        """Get the Resolved Scope configuration."""
+        return getattr(self, "_resolved_scope", None)
+
+    @resolved_scope.setter
+    def resolved_scope(self, scope: Scope) -> str:
+        """Resolve Scope Variables and Set Default Params.
+
+        Args:
+            scope: Call-time scope (takes precedence).
+
+        Returns:
+            Resolved Scope with all required fields.
+
+        Raises:
+            ScopeNotSetError: If required fields are missing.
+        """
+        self._resolved_scope = self._client._resolve_scope(scope)
+        # Call out to configure the default params
+        self.default_params = self._resolved_scope
+
+    def _wrapped_body(self, body: ResourceGroupCreateRequest) -> dict:
+        """Resolve and wrap the body payload to additionally inject scope details into the payload."""
+        if not self.should_wrap:
+            return body
+
+        body = body.model_dump(exclude_none=True)
+
+        if "accountIdentifier" not in body or body["accountIdentifier"] is None:
+            body["accountIdentifier"] = self.resolved_scope.account_id
+        if "orgIdentifier" not in body or body["orgIdentifier"] is None:
+            body["orgIdentifier"] = self.resolved_scope.org
+        if "projectIdentifier" not in body or body["projectIdentifier"] is None:
+            body["projectIdentifier"] = self.resolved_scope.project
+
+        return {self.unwrap_key: body}
+
+    def list(self, scope: Scope | None = None, **kwargs) -> Iterator[ResourceGroupResponse]:
+        """List resource_groups in the specified organization.
+
+        Args:
+            scope: Scope containing org. If None, uses client default scope.
+            **kwargs: Additional query parameters (e.g., searchTerm).
+
+        Yields:
+            ResourceGroupResponse: Individual resource_group items across all pages.
+
+        Raises:
+            ScopeNotSetError: If scope cannot be resolved.
+        """
+        self.resolved_scope = scope
+        kwargs.update(self.default_params)
+
+        url = self._client._build_url(
+            "{root_api_path}",
+            self.resolved_scope,
+            root_api_path=self.root_api_path,
+        )
+        return self._client._paginate(
+            url,
+            params=kwargs,
+            response_model=ResourceGroupResponse,
+            pagination_style=PaginationStyle.OFFSET,  # per pagination_inventory.md
+            scope=self.resolved_scope,
+            unwrap_field=self.unwrap_key,  # API wraps each item in a "self.unwrap_key" field
+        )
+
+    def get(self, identifier: str, scope: Scope | None = None) -> ResourceGroupResponse:
+        """Get a single resource_group by ID.
+
+        Args:
+            identifier: ResourceGroup identifier.
+            scope: Scope containing resource scope. If None, uses client default scope.
+
+        Returns:
+            ResourceGroupResponse: The requested resource_group.
+
+        Raises:
+            ScopeNotSetError: If scope cannot be resolved.
+            ApiError: For non-2xx responses.
+        """
+        self.resolved_scope = scope
+        url = self._client._build_url(
+            "{root_api_path}/{identifier}",
+            self.resolved_scope,
+            root_api_path=self.root_api_path,
+            identifier=identifier,
+        )
+
+        response = self._client._get(url, params=self.default_params, response_model=None)
+        if not response:
+            return {}
+
+        unwrapped = self._client._unwrap_response(
+            key_type=self.unwrap_key, raw_data=response, scope=self.resolved_scope
+        )
+        return ResourceGroupResponse(**unwrapped)
+
+    def create(
+        self, body: ResourceGroupCreateRequest, scope: Scope | None = None
+    ) -> ResourceGroupResponse:
+        """Create a new resource_group.
+
+        Args:
+            body: ResourceGroupCreateRequest request with required fields.
+            scope: Scope containing resource scope. If None, uses client default scope.
+            scope: Scope containing org. If None, uses client default scope.
+
+        Returns:
+            ResourceGroupResponse: The created resource_group.
+
+        Raises:
+            ScopeNotSetError: If scope cannot be resolved.
+            ApiError: For non-2xx responses.
+        """
+        self.resolved_scope = scope
+        url = self._client._build_url(
+            "{root_api_path}",
+            self.resolved_scope,
+            root_api_path=self.root_api_path,
+        )
+
+        response = self._client._post(
+            url, params=self.default_params, body=self._wrapped_body(body), response_model=None
+        )
+
+        unwrapped = self._client._unwrap_response(key_type=self.unwrap_key, raw_data=response)
+        return ResourceGroupResponse(**unwrapped)
+
+    def update(
+        self,
+        identifier: str,
+        body: ResourceGroupCreateRequest,
+        scope: Scope | None = None,
+    ) -> ResourceGroupResponse:
+        """Update an existing resource_group.
+
+        Args:
+            identifier: resource_group identifier.
+            body: ResourceGroupCreateRequest request with updated fields.
+            scope: Scope containing resource scope. If None, uses client default scope.
+
+        Returns:
+            ResourceGroupResponse: The updated resource_group.
+
+        Raises:
+            ScopeNotSetError: If scope cannot be resolved.
+            ApiError: For non-2xx responses.
+        """
+        self.resolved_scope = scope
+        url = self._client._build_url(
+            "{root_api_path}/{identifier}",
+            self.resolved_scope,
+            root_api_path=self.root_api_path,
+            identifier=identifier,
+        )
+
+        response = self._client._put(
+            url, params=self.default_params, body=self._wrapped_body(body), response_model=None
+        )
+
+        unwrapped = self._client._unwrap_response(key_type=self.unwrap_key, raw_data=response)
+        return ResourceGroupResponse(**unwrapped)
+
+    def delete(self, identifier: str, scope: Scope | None = None) -> dict | None:
+        """Delete a resource_group.
+
+        Args:
+            identifier: resource_group identifier.
+            scope: Scope containing resource scope. If None, uses client default scope.
+
+        Returns:
+            dict | None: Response data (typically empty for DELETE).
+
+        Raises:
+            ScopeNotSetError: If scope cannot be resolved.
+            ApiError: For non-2xx responses.
+        """
+        self.resolved_scope = scope
+        url = self._client._build_url(
+            "{root_api_path}/{identifier}",
+            self.resolved_scope,
+            root_api_path=self.root_api_path,
+            identifier=identifier,
+        )
+        return self._client._delete(url, params=self.default_params, response_model=None)

harness_platform_sdk/authz/role_assignments.py

@@ -0,0 +1,274 @@
+"""RoleAssignments API client for Harness SDK.
+
+Provides CRUD operations for role_assignment resources.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Iterator
+
+from harness_platform_sdk.client import HarnessClient
+from harness_platform_sdk.models.authz.role_assignments import (
+    RoleAssignmentCreateRequest,
+    RoleAssignmentResponse,
+)
+from harness_platform_sdk.pagination import PaginationStyle
+from harness_platform_sdk.scope import Scope
+
+
+class RoleAssignmentsApi:
+    """API client for role_assignment operations."""
+
+    def __init__(self, client: HarnessClient) -> None:
+        """Initialize RoleAssignmentsApi with HarnessClient.
+
+        Args:
+            client: HarnessClient instance for making requests.
+        """
+        self._client = client
+
+    @property
+    def root_api_path(self) -> str:
+        """Get the root API path for role assignment endpoints.
+
+        Returns:
+            str: The base API path for role assignment operations.
+        """
+        return "/authz/api/roleassignments"
+
+    @property
+    def unwrap_key(self) -> str:
+        """Get the response unwrap key for role assignment data.
+
+        Returns:
+            str: The key used to extract role assignment data from API responses.
+        """
+        return "roleAssignment"
+
+    @property
+    def should_wrap(self) -> bool:
+        """Check if request bodies should be wrapped.
+
+        Returns:
+            bool: False, as role assignment request bodies do not need wrapping.
+        """
+        return False
+
+    @property
+    def default_params(self):
+        """Get the Default Request Parameters configuration."""
+        return getattr(self, "_default_params", None)
+
+    @default_params.setter
+    def default_params(self, resolved: Scope) -> dict:
+        """Resolve Scope Variables and Set Default Params.
+
+        Args:
+            resolved: Scope containing account/org/project context.
+            scope: Call-time scope (takes precedence).
+
+        Returns:
+            Dictionary of Parsed Querystrings from the scope
+
+        Raises:
+            ScopeNotSetError: If required fields are missing.
+        """
+        self._default_params = self._client._build_url(
+            "&".join(
+                [
+                    "accountIdentifier={account_id}",
+                    "orgIdentifier={org}",
+                    "projectIdentifier={project}",
+                ]
+            ),
+            resolved,
+            is_params=True,
+        )
+
+    @property
+    def resolved_scope(self):
+        """Get the Resolved Scope configuration."""
+        return getattr(self, "_resolved_scope", None)
+
+    @resolved_scope.setter
+    def resolved_scope(self, scope: Scope) -> str:
+        """Resolve Scope Variables and Set Default Params.
+
+        Args:
+            scope: Call-time scope (takes precedence).
+
+        Returns:
+            Resolved Scope with all required fields.
+
+        Raises:
+            ScopeNotSetError: If required fields are missing.
+        """
+        self._resolved_scope = self._client._resolve_scope(scope)
+        # Call out to configure the default params
+        self.default_params = self._resolved_scope
+
+    def _wrapped_body(self, body: RoleAssignmentCreateRequest) -> dict:
+        """Resolve and wrap the body payload to additionally inject scope details into the payload."""
+        if not self.should_wrap:
+            return body
+
+        body = body.model_dump(exclude_none=True)
+
+        if "accountIdentifier" not in body or body["accountIdentifier"] is None:
+            body["accountIdentifier"] = self.resolved_scope.account_id
+        if "orgIdentifier" not in body or body["orgIdentifier"] is None:
+            body["orgIdentifier"] = self.resolved_scope.org
+        if "projectIdentifier" not in body or body["projectIdentifier"] is None:
+            body["projectIdentifier"] = self.resolved_scope.project
+
+        return {self.unwrap_key: body}
+
+    def list(self, scope: Scope | None = None, **kwargs) -> Iterator[RoleAssignmentResponse]:
+        """List role_assignments in the specified organization.
+
+        Args:
+            scope: Scope containing org. If None, uses client default scope.
+            **kwargs: Additional query parameters (e.g., searchTerm).
+
+        Yields:
+            RoleAssignmentResponse: Individual role_assignment items across all pages.
+
+        Raises:
+            ScopeNotSetError: If scope cannot be resolved.
+        """
+        self.resolved_scope = scope
+        kwargs.update(self.default_params)
+
+        url = self._client._build_url(
+            "{root_api_path}",
+            self.resolved_scope,
+            root_api_path=self.root_api_path,
+        )
+        return self._client._paginate(
+            url,
+            params=kwargs,
+            response_model=RoleAssignmentResponse,
+            pagination_style=PaginationStyle.OFFSET,  # per pagination_inventory.md
+            scope=self.resolved_scope,
+            unwrap_field=self.unwrap_key,  # API wraps each item in a "self.unwrap_key" field
+        )
+
+    def get(self, identifier: str, scope: Scope | None = None) -> RoleAssignmentResponse:
+        """Get a single role_assignment by ID.
+
+        Args:
+            identifier: RoleAssignment identifier.
+            scope: Scope containing resource scope. If None, uses client default scope.
+
+        Returns:
+            RoleAssignmentResponse: The requested role_assignment.
+
+        Raises:
+            ScopeNotSetError: If scope cannot be resolved.
+            ApiError: For non-2xx responses.
+        """
+        self.resolved_scope = scope
+        url = self._client._build_url(
+            "{root_api_path}/{identifier}",
+            self.resolved_scope,
+            root_api_path=self.root_api_path,
+            identifier=identifier,
+        )
+
+        response = self._client._get(url, params=self.default_params, response_model=None)
+        if not response:
+            return {}
+
+        unwrapped = self._client._unwrap_response(
+            key_type=self.unwrap_key, raw_data=response, scope=self.resolved_scope
+        )
+        return RoleAssignmentResponse(**unwrapped)
+
+    def create(
+        self, body: RoleAssignmentCreateRequest, scope: Scope | None = None
+    ) -> RoleAssignmentResponse:
+        """Create a new role_assignment.
+
+        Args:
+            body: RoleAssignmentCreateRequest request with required fields.
+            scope: Scope containing resource scope. If None, uses client default scope.
+            scope: Scope containing org. If None, uses client default scope.
+
+        Returns:
+            RoleAssignmentResponse: The created role_assignment.
+
+        Raises:
+            ScopeNotSetError: If scope cannot be resolved.
+            ApiError: For non-2xx responses.
+        """
+        self.resolved_scope = scope
+        url = self._client._build_url(
+            "{root_api_path}",
+            self.resolved_scope,
+            root_api_path=self.root_api_path,
+        )
+
+        response = self._client._post(
+            url, params=self.default_params, body=self._wrapped_body(body), response_model=None
+        )
+
+        unwrapped = self._client._unwrap_response(key_type=self.unwrap_key, raw_data=response)
+        return RoleAssignmentResponse(**unwrapped)
+
+    def update(
+        self,
+        identifier: str,
+        body: RoleAssignmentCreateRequest,
+        scope: Scope | None = None,
+    ) -> RoleAssignmentResponse:
+        """Update an existing role_assignment.
+
+        Args:
+            identifier: role_assignment identifier.
+            body: RoleAssignmentCreateRequest request with updated fields.
+            scope: Scope containing resource scope. If None, uses client default scope.
+
+        Returns:
+            RoleAssignmentResponse: The updated role_assignment.
+
+        Raises:
+            ScopeNotSetError: If scope cannot be resolved.
+            ApiError: For non-2xx responses.
+        """
+        self.resolved_scope = scope
+        url = self._client._build_url(
+            "{root_api_path}/{identifier}",
+            self.resolved_scope,
+            root_api_path=self.root_api_path,
+            identifier=identifier,
+        )
+
+        response = self._client._put(
+            url, params=self.default_params, body=self._wrapped_body(body), response_model=None
+        )
+
+        unwrapped = self._client._unwrap_response(key_type=self.unwrap_key, raw_data=response)
+        return RoleAssignmentResponse(**unwrapped)
+
+    def delete(self, identifier: str, scope: Scope | None = None) -> dict | None:
+        """Delete a role_assignment.
+
+        Args:
+            identifier: role_assignment identifier.
+            scope: Scope containing resource scope. If None, uses client default scope.
+
+        Returns:
+            dict | None: Response data (typically empty for DELETE).
+
+        Raises:
+            ScopeNotSetError: If scope cannot be resolved.
+            ApiError: For non-2xx responses.
+        """
+        self.resolved_scope = scope
+        url = self._client._build_url(
+            "{root_api_path}/{identifier}",
+            self.resolved_scope,
+            root_api_path=self.root_api_path,
+            identifier=identifier,
+        )
+        return self._client._delete(url, params=self.default_params, response_model=None)