gitcode-api 1.2.20__py3-none-any.whl → 1.3.0__py3-none-any.whl

gitcode_api/resources/collaboration/labels_resource_group.py

@@ -0,0 +1,248 @@
+"""AbstractLabelsResource, LabelsResource, and AsyncLabelsResource resource group."""
+
+from abc import ABC, abstractmethod
+from typing import List, Optional, Union
+
+from ..._models import Label
+from .._shared import AsyncResource, SyncResource
+
+# mypy: disable-error-code=override
+# pylint: disable=invalid-overridden-method,protected-access,redefined-builtin
+
+
+class AbstractLabelsResource(ABC):
+    """Interface for Labels resource endpoints."""
+
+    @abstractmethod
+    def list(self, *, owner: Optional[str] = None, repo: Optional[str] = None) -> List[Label]:
+        """List repository labels.
+
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :returns: All labels defined on the repository.
+        """
+
+    @abstractmethod
+    def create(self, *, name: str, color: str, owner: Optional[str] = None, repo: Optional[str] = None) -> Label:
+        """Create a repository label.
+
+        :param name: Label name.
+        :param color: Label color (typically a ``#RRGGBB`` hex string per API examples).
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :returns: Created label.
+        """
+
+    @abstractmethod
+    def update(
+        self,
+        *,
+        original_name: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        name: Optional[str] = None,
+        color: Optional[str] = None,
+    ) -> Label:
+        """Update a repository label.
+
+        :param original_name: Current label name in the URL path.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :param name: New label name, if renaming.
+        :param color: New color value.
+        :returns: Updated label.
+        """
+
+    @abstractmethod
+    def delete(self, *, name: str, owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        """Delete a repository label.
+
+        :param name: Label name in the path.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        """
+
+    @abstractmethod
+    def clear_issue_labels(
+        self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> None:
+        """Remove all labels from an issue.
+
+        :param number: Repository-local issue number.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        """
+
+    @abstractmethod
+    def replace_issue_labels(
+        self, *, number: Union[int, str], labels: List[str], owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> List[Label]:
+        """Replace all labels on an issue.
+
+        :param number: Repository-local issue number.
+        :param labels: Complete new label set (JSON array body).
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :returns: Labels after replacement.
+        """
+
+    @abstractmethod
+    def list_enterprise(
+        self,
+        *,
+        enterprise: str,
+        search: Optional[str] = None,
+        direction: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+        api_version: str = "v5",
+    ) -> List[Label]:
+        """List labels for an enterprise, optionally using a different API version.
+
+        :param enterprise: Enterprise path or login.
+        :param search: Optional name search string.
+        :param direction: Sort direction for results.
+        :param page: Page number.
+        :param per_page: Page size.
+        :param api_version: ``v5`` uses ``/api/v5/...``; other values build ``/api/{version}/...`` on the same host.
+        :returns: Enterprise label definitions.
+        """
+
+
+class LabelsResource(SyncResource, AbstractLabelsResource):
+    """Synchronous label endpoints."""
+
+    def list(self, *, owner: Optional[str] = None, repo: Optional[str] = None) -> List[Label]:
+        return self._models("GET", self._client._repo_path("labels", owner=owner, repo=repo), Label)
+
+    def create(self, *, name: str, color: str, owner: Optional[str] = None, repo: Optional[str] = None) -> Label:
+        return self._model(
+            "POST",
+            self._client._repo_path("labels", owner=owner, repo=repo),
+            Label,
+            json={"name": name, "color": color},
+        )
+
+    def update(
+        self,
+        *,
+        original_name: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        name: Optional[str] = None,
+        color: Optional[str] = None,
+    ) -> Label:
+        return self._model(
+            "PATCH",
+            self._client._repo_path("labels", original_name, owner=owner, repo=repo),
+            Label,
+            json={"name": name, "color": color},
+        )
+
+    def delete(self, *, name: str, owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        self._request("DELETE", self._client._repo_path("labels", name, owner=owner, repo=repo))
+
+    def clear_issue_labels(
+        self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> None:
+        self._request("DELETE", self._client._repo_path("issues", number, "labels", owner=owner, repo=repo))
+
+    def replace_issue_labels(
+        self, *, number: Union[int, str], labels: List[str], owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> List[Label]:
+        return self._models(
+            "PUT",
+            self._client._repo_path("issues", number, "labels", owner=owner, repo=repo),
+            Label,
+            json=labels,
+        )
+
+    def list_enterprise(
+        self,
+        *,
+        enterprise: str,
+        search: Optional[str] = None,
+        direction: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+        api_version: str = "v5",
+    ) -> List[Label]:
+        if api_version == "v5":
+            path = self._client._path("enterprises", enterprise, "labels")
+        else:
+            host = self._client.base_url.split("/api/", maxsplit=1)[0]
+            path = f"{host}/api/{api_version}/enterprises/{self._client._encode_segment(enterprise)}/labels"
+        return self._models(
+            "GET",
+            path,
+            Label,
+            params={"search": search, "direction": direction, "page": page, "per_page": per_page},
+        )
+
+
+class AsyncLabelsResource(AsyncResource, AbstractLabelsResource):
+    """Asynchronous label endpoints.
+
+    Mirrors :class:`LabelsResource`; see that class for parameter documentation.
+    """
+
+    async def list(self, *, owner: Optional[str] = None, repo: Optional[str] = None) -> List[Label]:
+        return await self._models("GET", self._client._repo_path("labels", owner=owner, repo=repo), Label)
+
+    async def create(self, *, name: str, color: str, owner: Optional[str] = None, repo: Optional[str] = None) -> Label:
+        return await self._model(
+            "POST",
+            self._client._repo_path("labels", owner=owner, repo=repo),
+            Label,
+            json={"name": name, "color": color},
+        )
+
+    async def update(
+        self,
+        *,
+        original_name: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        name: Optional[str] = None,
+        color: Optional[str] = None,
+    ) -> Label:
+        return await self._model(
+            "PATCH",
+            self._client._repo_path("labels", original_name, owner=owner, repo=repo),
+            Label,
+            json={"name": name, "color": color},
+        )
+
+    async def delete(self, *, name: str, owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        await self._request("DELETE", self._client._repo_path("labels", name, owner=owner, repo=repo))
+
+    async def clear_issue_labels(
+        self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> None:
+        await self._request("DELETE", self._client._repo_path("issues", number, "labels", owner=owner, repo=repo))
+
+    async def replace_issue_labels(
+        self, *, number: Union[int, str], labels: List[str], owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> List[Label]:
+        return await self._models(
+            "PUT", self._client._repo_path("issues", number, "labels", owner=owner, repo=repo), Label, json=labels
+        )
+
+    async def list_enterprise(
+        self,
+        *,
+        enterprise: str,
+        search: Optional[str] = None,
+        direction: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+        api_version: str = "v5",
+    ) -> List[Label]:
+        if api_version == "v5":
+            path = self._client._path("enterprises", enterprise, "labels")
+        else:
+            host = self._client.base_url.split("/api/", maxsplit=1)[0]
+            path = f"{host}/api/{api_version}/enterprises/{self._client._encode_segment(enterprise)}/labels"
+        return await self._models(
+            "GET", path, Label, params={"search": search, "direction": direction, "page": page, "per_page": per_page}
+        )

gitcode_api/resources/collaboration/members_resource_group.py

@@ -0,0 +1,195 @@
+"""AbstractMembersResource, MembersResource, and AsyncMembersResource resource group."""
+
+from abc import ABC, abstractmethod
+from typing import List, Optional
+
+from ..._models import (
+    RepoCollaborator,
+    RepoMember,
+    RepoMemberPermission,
+    RepositoryCollaboratorCheck,
+)
+from .._shared import AsyncResource, SyncResource
+
+# mypy: disable-error-code=override
+# pylint: disable=invalid-overridden-method,protected-access,redefined-builtin
+
+
+class AbstractMembersResource(ABC):
+    """Interface for Members resource endpoints."""
+
+    @abstractmethod
+    def add_or_update(
+        self,
+        *,
+        username: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        permission: Optional[str] = None,
+    ) -> RepoMember:
+        """Add or update repository member permissions.
+
+        :param username: Collaborator login.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :param permission: Permission string (for example ``pull``, ``push``, ``admin`` per GitCode API).
+        :returns: Collaborator record.
+        """
+
+    @abstractmethod
+    def remove(self, *, username: str, owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        """Remove a repository member.
+
+        :param username: Collaborator login to remove.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        """
+
+    @abstractmethod
+    def list(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[RepoCollaborator]:
+        """List repository members (collaborators).
+
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :param page: Page number.
+        :param per_page: Page size.
+        :returns: Collaborators with permission metadata.
+        """
+
+    @abstractmethod
+    def get(
+        self, *, username: str, owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> RepositoryCollaboratorCheck:
+        """Check whether a user is a repository member."""
+
+    @abstractmethod
+    def get_permission(
+        self, *, username: str, owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> RepoMemberPermission:
+        """Get repository member permissions.
+
+        :param username: Collaborator login.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :returns: Effective permission for the user on the repository.
+        """
+
+
+class MembersResource(SyncResource, AbstractMembersResource):
+    """Synchronous repository member endpoints."""
+
+    def add_or_update(
+        self,
+        *,
+        username: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        permission: Optional[str] = None,
+    ) -> RepoMember:
+        return self._model(
+            "PUT",
+            self._client._repo_path("collaborators", username, owner=owner, repo=repo),
+            RepoMember,
+            json={"permission": permission},
+        )
+
+    def remove(self, *, username: str, owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        self._request("DELETE", self._client._repo_path("collaborators", username, owner=owner, repo=repo))
+
+    def list(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[RepoCollaborator]:
+        return self._models(
+            "GET",
+            self._client._repo_path("collaborators", owner=owner, repo=repo),
+            RepoCollaborator,
+            params={"page": page, "per_page": per_page},
+        )
+
+    def get(
+        self, *, username: str, owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> RepositoryCollaboratorCheck:
+        return self._model(
+            "GET",
+            self._client._repo_path("collaborators", username, owner=owner, repo=repo),
+            RepositoryCollaboratorCheck,
+        )
+
+    def get_permission(
+        self, *, username: str, owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> RepoMemberPermission:
+        return self._model(
+            "GET",
+            self._client._repo_path("collaborators", username, "permission", owner=owner, repo=repo),
+            RepoMemberPermission,
+        )
+
+
+class AsyncMembersResource(AsyncResource, AbstractMembersResource):
+    """Asynchronous repository member endpoints.
+
+    Mirrors :class:`MembersResource` (collaborators API); see that class for parameters.
+    """
+
+    async def add_or_update(
+        self,
+        *,
+        username: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        permission: Optional[str] = None,
+    ) -> RepoMember:
+        return await self._model(
+            "PUT",
+            self._client._repo_path("collaborators", username, owner=owner, repo=repo),
+            RepoMember,
+            json={"permission": permission},
+        )
+
+    async def remove(self, *, username: str, owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        await self._request("DELETE", self._client._repo_path("collaborators", username, owner=owner, repo=repo))
+
+    async def list(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[RepoCollaborator]:
+        return await self._models(
+            "GET",
+            self._client._repo_path("collaborators", owner=owner, repo=repo),
+            RepoCollaborator,
+            params={"page": page, "per_page": per_page},
+        )
+
+    async def get(
+        self, *, username: str, owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> RepositoryCollaboratorCheck:
+        return await self._model(
+            "GET",
+            self._client._repo_path("collaborators", username, owner=owner, repo=repo),
+            RepositoryCollaboratorCheck,
+        )
+
+    async def get_permission(
+        self, *, username: str, owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> RepoMemberPermission:
+        return await self._model(
+            "GET",
+            self._client._repo_path("collaborators", username, "permission", owner=owner, repo=repo),
+            RepoMemberPermission,
+        )

gitcode_api/resources/collaboration/milestones_resource_group.py

@@ -0,0 +1,192 @@
+"""AbstractMilestonesResource, MilestonesResource, and AsyncMilestonesResource resource group."""
+
+from abc import ABC, abstractmethod
+from typing import List, Optional, Union
+
+from ..._models import Milestone
+from .._shared import AsyncResource, SyncResource
+
+# mypy: disable-error-code=override
+# pylint: disable=invalid-overridden-method,protected-access,redefined-builtin
+
+
+class AbstractMilestonesResource(ABC):
+    """Interface for Milestones resource endpoints."""
+
+    @abstractmethod
+    def list(self, *, owner: Optional[str] = None, repo: Optional[str] = None, **params) -> List[Milestone]:
+        """List milestones for a repository.
+
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :param params: Query parameters accepted by the milestones listing (state, sort, pagination, etc.).
+        :returns: Milestones.
+        """
+
+    @abstractmethod
+    def get(self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> Milestone:
+        """Get a single milestone.
+
+        :param number: Milestone number in the repository.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :returns: Milestone details.
+        """
+
+    @abstractmethod
+    def create(
+        self,
+        *,
+        title: str,
+        due_on: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        description: Optional[str] = None,
+    ) -> Milestone:
+        """Create a milestone.
+
+        :param title: Milestone title.
+        :param due_on: Due date string in the format expected by the API (often ISO 8601).
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :param description: Optional description.
+        :returns: Created milestone.
+        """
+
+    @abstractmethod
+    def update(
+        self,
+        *,
+        number: Union[int, str],
+        title: str,
+        due_on: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        description: Optional[str] = None,
+        state: Optional[str] = None,
+    ) -> Milestone:
+        """Update a milestone.
+
+        :param number: Milestone number.
+        :param title: Updated title.
+        :param due_on: Updated due date.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :param description: Updated description.
+        :param state: Milestone state such as ``open`` or ``closed`` per API.
+        :returns: Updated milestone.
+        """
+
+    @abstractmethod
+    def delete(self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        """Delete a milestone.
+
+        :param number: Milestone number.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        """
+
+
+class MilestonesResource(SyncResource, AbstractMilestonesResource):
+    """Synchronous milestone endpoints."""
+
+    def list(self, *, owner: Optional[str] = None, repo: Optional[str] = None, **params) -> List[Milestone]:
+        return self._models(
+            "GET", self._client._repo_path("milestones", owner=owner, repo=repo), Milestone, params=params
+        )
+
+    def get(self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> Milestone:
+        return self._model("GET", self._client._repo_path("milestones", number, owner=owner, repo=repo), Milestone)
+
+    def create(
+        self,
+        *,
+        title: str,
+        due_on: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        description: Optional[str] = None,
+    ) -> Milestone:
+        return self._model(
+            "POST",
+            self._client._repo_path("milestones", owner=owner, repo=repo),
+            Milestone,
+            json={"title": title, "due_on": due_on, "description": description},
+        )
+
+    def update(
+        self,
+        *,
+        number: Union[int, str],
+        title: str,
+        due_on: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        description: Optional[str] = None,
+        state: Optional[str] = None,
+    ) -> Milestone:
+        return self._model(
+            "PATCH",
+            self._client._repo_path("milestones", number, owner=owner, repo=repo),
+            Milestone,
+            json={"title": title, "due_on": due_on, "description": description, "state": state},
+        )
+
+    def delete(self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        self._request("DELETE", self._client._repo_path("milestones", number, owner=owner, repo=repo))
+
+
+class AsyncMilestonesResource(AsyncResource, AbstractMilestonesResource):
+    """Asynchronous milestone endpoints.
+
+    Mirrors :class:`MilestonesResource`; see that class for parameter documentation.
+    """
+
+    async def list(self, *, owner: Optional[str] = None, repo: Optional[str] = None, **params) -> List[Milestone]:
+        return await self._models(
+            "GET", self._client._repo_path("milestones", owner=owner, repo=repo), Milestone, params=params
+        )
+
+    async def get(
+        self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> Milestone:
+        return await self._model(
+            "GET", self._client._repo_path("milestones", number, owner=owner, repo=repo), Milestone
+        )
+
+    async def create(
+        self,
+        *,
+        title: str,
+        due_on: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        description: Optional[str] = None,
+    ) -> Milestone:
+        return await self._model(
+            "POST",
+            self._client._repo_path("milestones", owner=owner, repo=repo),
+            Milestone,
+            json={"title": title, "due_on": due_on, "description": description},
+        )
+
+    async def update(
+        self,
+        *,
+        number: Union[int, str],
+        title: str,
+        due_on: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        description: Optional[str] = None,
+        state: Optional[str] = None,
+    ) -> Milestone:
+        return await self._model(
+            "PATCH",
+            self._client._repo_path("milestones", number, owner=owner, repo=repo),
+            Milestone,
+            json={"title": title, "due_on": due_on, "description": description, "state": state},
+        )
+
+    async def delete(self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        await self._request("DELETE", self._client._repo_path("milestones", number, owner=owner, repo=repo))