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

gitcode_api/resources/misc/tags_resource_group.py

@@ -0,0 +1,286 @@
+"""AbstractTagsResource, TagsResource, and AsyncTagsResource resource group."""
+
+from abc import ABC, abstractmethod
+from typing import List, Optional
+
+from ..._models import ProtectedTag, Tag
+from .._shared import AsyncResource, SyncResource
+
+# mypy: disable-error-code=override
+# pylint: disable=invalid-overridden-method,protected-access,redefined-builtin
+
+
+class AbstractTagsResource(ABC):
+    """Interface for Tags resource endpoints."""
+
+    @abstractmethod
+    def list(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[Tag]:
+        """List tags 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 page: Page number.
+        :param per_page: Page size.
+        :returns: Tags.
+        """
+
+    @abstractmethod
+    def create(
+        self,
+        *,
+        refs: str,
+        tag_name: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        tag_message: Optional[str] = None,
+    ) -> Tag:
+        """Create a tag for a repository.
+
+        :param refs: Object SHA or ref the tag should point to.
+        :param tag_name: Name of the new tag.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :param tag_message: Optional annotated tag message.
+        :returns: Created tag.
+        """
+
+    @abstractmethod
+    def list_protected(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[ProtectedTag]:
+        """List protected tags 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 page: Page number.
+        :param per_page: Page size.
+        :returns: Protected tag rules.
+        """
+
+    @abstractmethod
+    def delete_protected(self, *, tag_name: str, owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        """Delete a protected tag rule.
+
+        :param tag_name: Protected tag 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.
+        """
+
+    @abstractmethod
+    def get_protected(self, *, tag_name: str, owner: Optional[str] = None, repo: Optional[str] = None) -> ProtectedTag:
+        """Get details for a protected tag rule.
+
+        :param tag_name: Tag 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.
+        :returns: Protected tag configuration.
+        """
+
+    @abstractmethod
+    def create_protected(
+        self,
+        *,
+        name: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        create_access_level: Optional[int] = None,
+    ) -> ProtectedTag:
+        """Create a protected tag rule.
+
+        :param name: Tag name or pattern to protect.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :param create_access_level: Minimum access level required to create matching tags (API-specific integer).
+        :returns: Created rule.
+        """
+
+    @abstractmethod
+    def update_protected(
+        self, *, name: str, create_access_level: int, owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> ProtectedTag:
+        """Update a protected tag rule."""
+
+
+class TagsResource(SyncResource, AbstractTagsResource):
+    """Synchronous tag endpoints."""
+
+    def list(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[Tag]:
+        return self._models(
+            "GET",
+            self._client._repo_path("tags", owner=owner, repo=repo),
+            Tag,
+            params={"page": page, "per_page": per_page},
+        )
+
+    def create(
+        self,
+        *,
+        refs: str,
+        tag_name: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        tag_message: Optional[str] = None,
+    ) -> Tag:
+        return self._model(
+            "POST",
+            self._client._repo_path("tags", owner=owner, repo=repo),
+            Tag,
+            json={"refs": refs, "tag_name": tag_name, "tag_message": tag_message},
+        )
+
+    def list_protected(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[ProtectedTag]:
+        return self._models(
+            "GET",
+            self._client._repo_path("protected_tags", owner=owner, repo=repo),
+            ProtectedTag,
+            params={"page": page, "per_page": per_page},
+        )
+
+    def delete_protected(self, *, tag_name: str, owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        self._request("DELETE", self._client._repo_path("protected_tags", tag_name, owner=owner, repo=repo))
+
+    def get_protected(self, *, tag_name: str, owner: Optional[str] = None, repo: Optional[str] = None) -> ProtectedTag:
+        return self._model(
+            "GET",
+            self._client._repo_path("protected_tags", tag_name, owner=owner, repo=repo),
+            ProtectedTag,
+        )
+
+    def create_protected(
+        self,
+        *,
+        name: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        create_access_level: Optional[int] = None,
+    ) -> ProtectedTag:
+        return self._model(
+            "POST",
+            self._client._repo_path("protected_tags", owner=owner, repo=repo),
+            ProtectedTag,
+            json={"name": name, "create_access_level": create_access_level},
+        )
+
+    def update_protected(
+        self, *, name: str, create_access_level: int, owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> ProtectedTag:
+        return self._model(
+            "PUT",
+            self._client._repo_path("protected_tags", owner=owner, repo=repo),
+            ProtectedTag,
+            json={"name": name, "create_access_level": create_access_level},
+        )
+
+
+class AsyncTagsResource(AsyncResource, AbstractTagsResource):
+    """Asynchronous tag endpoints.
+
+    Mirrors :class:`TagsResource`; see that class and ``docs/rest_api/repos/tag`` for semantics.
+    """
+
+    async def list(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[Tag]:
+        return await self._models(
+            "GET",
+            self._client._repo_path("tags", owner=owner, repo=repo),
+            Tag,
+            params={"page": page, "per_page": per_page},
+        )
+
+    async def create(
+        self,
+        *,
+        refs: str,
+        tag_name: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        tag_message: Optional[str] = None,
+    ) -> Tag:
+        return await self._model(
+            "POST",
+            self._client._repo_path("tags", owner=owner, repo=repo),
+            Tag,
+            json={"refs": refs, "tag_name": tag_name, "tag_message": tag_message},
+        )
+
+    async def list_protected(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[ProtectedTag]:
+        return await self._models(
+            "GET",
+            self._client._repo_path("protected_tags", owner=owner, repo=repo),
+            ProtectedTag,
+            params={"page": page, "per_page": per_page},
+        )
+
+    async def delete_protected(self, *, tag_name: str, owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        await self._request("DELETE", self._client._repo_path("protected_tags", tag_name, owner=owner, repo=repo))
+
+    async def get_protected(
+        self, *, tag_name: str, owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> ProtectedTag:
+        return await self._model(
+            "GET", self._client._repo_path("protected_tags", tag_name, owner=owner, repo=repo), ProtectedTag
+        )
+
+    async def create_protected(
+        self,
+        *,
+        name: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        create_access_level: Optional[int] = None,
+    ) -> ProtectedTag:
+        return await self._model(
+            "POST",
+            self._client._repo_path("protected_tags", owner=owner, repo=repo),
+            ProtectedTag,
+            json={"name": name, "create_access_level": create_access_level},
+        )
+
+    async def update_protected(
+        self, *, name: str, create_access_level: int, owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> ProtectedTag:
+        return await self._model(
+            "PUT",
+            self._client._repo_path("protected_tags", owner=owner, repo=repo),
+            ProtectedTag,
+            json={"name": name, "create_access_level": create_access_level},
+        )

gitcode_api/resources/misc/webhooks_resource_group.py

@@ -0,0 +1,192 @@
+"""AbstractWebhooksResource, WebhooksResource, and AsyncWebhooksResource resource group."""
+
+from abc import ABC, abstractmethod
+from typing import List, Optional, Union
+
+from ..._models import Webhook
+from .._shared import AsyncResource, SyncResource
+
+# mypy: disable-error-code=override
+# pylint: disable=invalid-overridden-method,protected-access,redefined-builtin
+
+
+class AbstractWebhooksResource(ABC):
+    """Interface for Webhooks resource endpoints."""
+
+    @abstractmethod
+    def list(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[Webhook]:
+        """List webhooks 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 page: Page number.
+        :param per_page: Page size.
+        :returns: Hook configurations.
+        """
+
+    @abstractmethod
+    def create(self, *, url: str, owner: Optional[str] = None, repo: Optional[str] = None, **payload) -> Webhook:
+        """Create a repository webhook.
+
+        :param url: Payload URL GitCode should POST events to.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :param payload: Additional fields from the Webhooks API (events list, secret, content type, etc.).
+        :returns: Created webhook.
+        """
+
+    @abstractmethod
+    def get(self, *, hook_id: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> Webhook:
+        """Get a repository webhook by identifier.
+
+        :param hook_id: Webhook id from the API.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :returns: Webhook configuration.
+        """
+
+    @abstractmethod
+    def update(
+        self,
+        *,
+        hook_id: Union[int, str],
+        url: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        **payload,
+    ) -> Webhook:
+        """Update a repository webhook.
+
+        :param hook_id: Webhook id.
+        :param url: New payload URL (merged into the JSON body).
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        :param payload: Other mutable webhook fields accepted by the API.
+        :returns: Updated webhook.
+        """
+
+    @abstractmethod
+    def delete(self, *, hook_id: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        """Delete a repository webhook.
+
+        :param hook_id: Webhook id.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        """
+
+    @abstractmethod
+    def test(self, *, hook_id: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        """Send a test delivery for a repository webhook.
+
+        :param hook_id: Webhook id.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository path. Uses the client default when omitted.
+        """
+
+
+class WebhooksResource(SyncResource, AbstractWebhooksResource):
+    """Synchronous webhook endpoints."""
+
+    def list(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[Webhook]:
+        return self._models(
+            "GET",
+            self._client._repo_path("hooks", owner=owner, repo=repo),
+            Webhook,
+            params={"page": page, "per_page": per_page},
+        )
+
+    def create(self, *, url: str, owner: Optional[str] = None, repo: Optional[str] = None, **payload) -> Webhook:
+        payload["url"] = url
+        return self._model("POST", self._client._repo_path("hooks", owner=owner, repo=repo), Webhook, json=payload)
+
+    def get(self, *, hook_id: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> Webhook:
+        return self._model("GET", self._client._repo_path("hooks", hook_id, owner=owner, repo=repo), Webhook)
+
+    def update(
+        self,
+        *,
+        hook_id: Union[int, str],
+        url: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        **payload,
+    ) -> Webhook:
+        payload["url"] = url
+        return self._model(
+            "PATCH", self._client._repo_path("hooks", hook_id, owner=owner, repo=repo), Webhook, json=payload
+        )
+
+    def delete(self, *, hook_id: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        self._request("DELETE", self._client._repo_path("hooks", hook_id, owner=owner, repo=repo))
+
+    def test(self, *, hook_id: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        self._request("POST", self._client._repo_path("hooks", hook_id, "tests", owner=owner, repo=repo))
+
+
+class AsyncWebhooksResource(AsyncResource, AbstractWebhooksResource):
+    """Asynchronous webhook endpoints.
+
+    Mirrors :class:`WebhooksResource`; see that class and ``docs/rest_api/repos/webhooks``.
+    """
+
+    async def list(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[Webhook]:
+        return await self._models(
+            "GET",
+            self._client._repo_path("hooks", owner=owner, repo=repo),
+            Webhook,
+            params={"page": page, "per_page": per_page},
+        )
+
+    async def create(self, *, url: str, owner: Optional[str] = None, repo: Optional[str] = None, **payload) -> Webhook:
+        payload["url"] = url
+        return await self._model(
+            "POST", self._client._repo_path("hooks", owner=owner, repo=repo), Webhook, json=payload
+        )
+
+    async def get(
+        self, *, hook_id: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> Webhook:
+        return await self._model("GET", self._client._repo_path("hooks", hook_id, owner=owner, repo=repo), Webhook)
+
+    async def update(
+        self,
+        *,
+        hook_id: Union[int, str],
+        url: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        **payload,
+    ) -> Webhook:
+        payload["url"] = url
+        return await self._model(
+            "PATCH", self._client._repo_path("hooks", hook_id, owner=owner, repo=repo), Webhook, json=payload
+        )
+
+    async def delete(
+        self, *, hook_id: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
+    ) -> None:
+        await self._request("DELETE", self._client._repo_path("hooks", hook_id, owner=owner, repo=repo))
+
+    async def test(self, *, hook_id: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> None:
+        await self._request("POST", self._client._repo_path("hooks", hook_id, "tests", owner=owner, repo=repo))

gitcode_api/resources/repositories/__init__.py

@@ -0,0 +1,17 @@
+"""Classes for resource groups: branches, commits, file contents, and repositories."""
+
+from .branches_resource_group import AsyncBranchesResource, BranchesResource
+from .commits_resource_group import AsyncCommitsResource, CommitsResource
+from .repo_contents_resource_group import AsyncRepoContentsResource, RepoContentsResource
+from .repos_resource_group import AsyncReposResource, ReposResource
+
+__all__ = [
+    "AsyncBranchesResource",
+    "AsyncCommitsResource",
+    "AsyncRepoContentsResource",
+    "AsyncReposResource",
+    "BranchesResource",
+    "CommitsResource",
+    "RepoContentsResource",
+    "ReposResource",
+]

gitcode_api/resources/repositories/branches_resource_group.py

@@ -0,0 +1,151 @@
+"""AbstractBranchesResource, BranchesResource, and AsyncBranchesResource resource group."""
+
+from abc import ABC, abstractmethod
+from typing import List, Optional
+
+from ..._models import (
+    Branch,
+    BranchDetail,
+    ProtectedBranch,
+)
+from .._shared import AsyncResource, SyncResource
+
+# mypy: disable-error-code=override
+# pylint: disable=invalid-overridden-method,protected-access,redefined-builtin
+
+
+class AbstractBranchesResource(ABC):
+    """Interface for Branches resource endpoints."""
+
+    @abstractmethod
+    def list(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        sort: Optional[str] = None,
+        direction: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[Branch]:
+        """List branches in a repository.
+
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository name. Uses the client default when omitted.
+        :param sort: Optional sort field such as ``name`` or ``updated``.
+        :param direction: Sort direction, usually ``asc`` or ``desc``.
+        :param page: Page number.
+        :param per_page: Page size.
+        :returns: Repository branches.
+        """
+
+    @abstractmethod
+    def get(self, *, branch: str, owner: Optional[str] = None, repo: Optional[str] = None) -> BranchDetail:
+        """Get a single branch.
+
+        :param branch: Branch name.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository name. Uses the client default when omitted.
+        :returns: Branch details.
+        """
+
+    @abstractmethod
+    def create(self, *, branch: str, ref: str, owner: Optional[str] = None, repo: Optional[str] = None) -> Branch:
+        """Create a branch from an existing ref.
+
+        :param branch: New branch name.
+        :param ref: Starting ref such as a branch, tag, or commit SHA.
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository name. Uses the client default when omitted.
+        :returns: Created branch details.
+        """
+
+    @abstractmethod
+    def list_protected(self, *, owner: Optional[str] = None, repo: Optional[str] = None) -> List[ProtectedBranch]:
+        """List protected branch rules for a repository.
+
+        :param owner: Repository owner path. Uses the client default when omitted.
+        :param repo: Repository name. Uses the client default when omitted.
+        :returns: Protected branch rules.
+        """
+
+
+class BranchesResource(SyncResource, AbstractBranchesResource):
+    """Synchronous branch endpoints."""
+
+    def list(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        sort: Optional[str] = None,
+        direction: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[Branch]:
+        return self._models(
+            "GET",
+            self._client._repo_path("branches", owner=owner, repo=repo),
+            Branch,
+            params={"sort": sort, "direction": direction, "page": page, "per_page": per_page},
+        )
+
+    def get(self, *, branch: str, owner: Optional[str] = None, repo: Optional[str] = None) -> BranchDetail:
+        return self._model("GET", self._client._repo_path("branches", branch, owner=owner, repo=repo), BranchDetail)
+
+    def create(self, *, branch: str, ref: str, owner: Optional[str] = None, repo: Optional[str] = None) -> Branch:
+        return self._model(
+            "POST",
+            self._client._repo_path("branches", owner=owner, repo=repo),
+            Branch,
+            json={"branch_name": branch, "refs": ref},
+        )
+
+    def list_protected(self, *, owner: Optional[str] = None, repo: Optional[str] = None) -> List[ProtectedBranch]:
+        return self._models(
+            "GET",
+            self._client._repo_path("protect_branches", owner=owner, repo=repo),
+            ProtectedBranch,
+        )
+
+
+class AsyncBranchesResource(AsyncResource, AbstractBranchesResource):
+    """Asynchronous branch endpoints.
+
+    Mirrors :class:`BranchesResource` (``docs/rest_api/repos/branch``).
+    """
+
+    async def list(
+        self,
+        *,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        sort: Optional[str] = None,
+        direction: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+    ) -> List[Branch]:
+        return await self._models(
+            "GET",
+            self._client._repo_path("branches", owner=owner, repo=repo),
+            Branch,
+            params={"sort": sort, "direction": direction, "page": page, "per_page": per_page},
+        )
+
+    async def get(self, *, branch: str, owner: Optional[str] = None, repo: Optional[str] = None) -> BranchDetail:
+        return await self._model(
+            "GET", self._client._repo_path("branches", branch, owner=owner, repo=repo), BranchDetail
+        )
+
+    async def create(self, *, branch: str, ref: str, owner: Optional[str] = None, repo: Optional[str] = None) -> Branch:
+        return await self._model(
+            "POST",
+            self._client._repo_path("branches", owner=owner, repo=repo),
+            Branch,
+            json={"branch_name": branch, "refs": ref},
+        )
+
+    async def list_protected(self, *, owner: Optional[str] = None, repo: Optional[str] = None) -> List[ProtectedBranch]:
+        return await self._models(
+            "GET", self._client._repo_path("protect_branches", owner=owner, repo=repo), ProtectedBranch
+        )