gitcode-api 1.3.2__py3-none-any.whl → 1.3.3__py3-none-any.whl

gitcode_api/cli.py

@@ -281,7 +281,7 @@ Examples:
   %(prog)s users me --api-key "$GITCODE_ACCESS_TOKEN"
   %(prog)s pulls list --set only_count=true --set reviewer=demo
 
-Extra keyword arguments (**params / **payload on some methods):
+Extra keyword arguments (when needed):
   Repeat --set key=value (value is JSON if it parses as JSON; otherwise a string).
   --set-json merges one JSON object (or @path/to/file.json) into those kwargs.
 
@@ -375,7 +375,7 @@ Each method -h opens with resource.method_signature("<name>") from the Python SD
                             action="append",
                             default=None,
                             metavar="KEY=VALUE",
-                            help="Extra keyword argument (merged into **params / **payload).",
+                            help="Extra keyword arguments.",
                         )
                         method_parser.add_argument(
                             "--set-json",

gitcode_api/resources/account/orgs_resource_group.py

@@ -77,16 +77,43 @@ class AbstractOrgsResource(ABC):
         """
 
     @abstractmethod
-    def create_repo(self, *, org: str, name: str, **payload) -> Repository:
+    def create_repo(
+        self,
+        *,
+        org: str,
+        name: str,
+        description: Optional[str] = None,
+        homepage: Optional[str] = None,
+        has_issues: Optional[bool] = None,
+        has_wiki: Optional[bool] = None,
+        can_comment: Optional[bool] = None,
+        public: Optional[int] = None,
+        private: Optional[bool] = None,
+        auto_init: Optional[bool] = None,
+        gitignore_template: Optional[str] = None,
+        license_template: Optional[str] = None,
+        path: Optional[str] = None,
+        default_branch: Optional[str] = None,
+        **kwargs,
+    ) -> Repository:
         """Create an organization repository.
 
-        Additional payload fields match the organization repository creation
-        endpoint, such as ``description``, ``homepage``, ``private``,
-        ``public``, ``auto_init``, and ``default_branch``.
-
         :param org: Organization path or login.
         :param name: Repository name.
-        :param payload: Additional repository creation fields.
+        :param description: Repository description.
+        :param homepage: Homepage URL.
+        :param has_issues: Allow issues to be created. Default: ``True``.
+        :param has_wiki: Provide wiki. Default: ``True``.
+        :param can_comment: Allow users to comment on repositories. Default: ``True``.
+        :param public: Open source type: ``0`` (private), ``1`` (external), ``2`` (internal).
+            Mutually exclusive with *private*.
+        :param private: Repository visibility. Mutually exclusive with *public*.
+        :param auto_init: Initialize with a README. Default: ``False``.
+        :param gitignore_template: ``.gitignore`` template name.
+        :param license_template: License template name.
+        :param path: Repository path.
+        :param default_branch: Default branch name. Default: ``main``.
+        :param kwargs: Additional arguments forwarded directly in request.
         :returns: Created repository metadata.
         """
 
@@ -184,11 +211,26 @@ class AbstractOrgsResource(ABC):
         """
 
     @abstractmethod
-    def update(self, *, org: str, **payload) -> Organization:
+    def update(
+        self,
+        *,
+        org: str,
+        name: Optional[str] = None,
+        email: Optional[str] = None,
+        location: Optional[str] = None,
+        description: Optional[str] = None,
+        html_url: Optional[str] = None,
+        **kwargs,
+    ) -> Organization:
         """Update organization metadata.
 
         :param org: Organization path or login.
-        :param payload: Updatable fields such as ``name``, ``email``, or ``description``.
+        :param name: Organization name.
+        :param email: Organization email.
+        :param location: Organization location.
+        :param description: Organization description.
+        :param html_url: Organization site URL.
+        :param kwargs: Additional arguments forwarded directly in request.
         :returns: Updated organization details.
         """
 
@@ -239,9 +281,46 @@ class OrgsResource(SyncResource, AbstractOrgsResource):
             params={"type": type, "page": page, "per_page": per_page},
         )
 
-    def create_repo(self, *, org: str, name: str, **payload) -> Repository:
-        payload["name"] = name
-        return self._model("POST", self._client._path("orgs", org, "repos"), Repository, json=payload)
+    def create_repo(
+        self,
+        *,
+        org: str,
+        name: str,
+        description: Optional[str] = None,
+        homepage: Optional[str] = None,
+        has_issues: Optional[bool] = None,
+        has_wiki: Optional[bool] = None,
+        can_comment: Optional[bool] = None,
+        public: Optional[int] = None,
+        private: Optional[bool] = None,
+        auto_init: Optional[bool] = None,
+        gitignore_template: Optional[str] = None,
+        license_template: Optional[str] = None,
+        path: Optional[str] = None,
+        default_branch: Optional[str] = None,
+        **kwargs,
+    ) -> Repository:
+        return self._model(
+            "POST",
+            self._client._path("orgs", org, "repos"),
+            Repository,
+            json={
+                "name": name,
+                "description": description,
+                "homepage": homepage,
+                "has_issues": has_issues,
+                "has_wiki": has_wiki,
+                "can_comment": can_comment,
+                "public": public,
+                "private": private,
+                "auto_init": auto_init,
+                "gitignore_template": gitignore_template,
+                "license_template": license_template,
+                "path": path,
+                "default_branch": default_branch,
+                **kwargs,
+            },
+        )
 
     def get_enterprise_member(self, *, enterprise: str, username: str) -> EnterpriseMember:
         return self._model("GET", self._client._path("enterprises", enterprise, "members", username), EnterpriseMember)
@@ -302,8 +381,30 @@ class OrgsResource(SyncResource, AbstractOrgsResource):
             json={"role": role},
         )
 
-    def update(self, *, org: str, **payload) -> Organization:
-        return self._model("PATCH", self._client._path("orgs", org), Organization, json=payload)
+    def update(
+        self,
+        *,
+        org: str,
+        name: Optional[str] = None,
+        email: Optional[str] = None,
+        location: Optional[str] = None,
+        description: Optional[str] = None,
+        html_url: Optional[str] = None,
+        **kwargs,
+    ) -> Organization:
+        return self._model(
+            "PATCH",
+            self._client._path("orgs", org),
+            Organization,
+            json={
+                "name": name,
+                "email": email,
+                "location": location,
+                "description": description,
+                "html_url": html_url,
+                **kwargs,
+            },
+        )
 
     def leave(self, *, org: str) -> None:
         self._request("DELETE", self._client._path("user", "memberships", "orgs", org))
@@ -351,9 +452,46 @@ class AsyncOrgsResource(AsyncResource, AbstractOrgsResource):
             params={"type": type, "page": page, "per_page": per_page},
         )
 
-    async def create_repo(self, *, org: str, name: str, **payload) -> Repository:
-        payload["name"] = name
-        return await self._model("POST", self._client._path("orgs", org, "repos"), Repository, json=payload)
+    async def create_repo(
+        self,
+        *,
+        org: str,
+        name: str,
+        description: Optional[str] = None,
+        homepage: Optional[str] = None,
+        has_issues: Optional[bool] = None,
+        has_wiki: Optional[bool] = None,
+        can_comment: Optional[bool] = None,
+        public: Optional[int] = None,
+        private: Optional[bool] = None,
+        auto_init: Optional[bool] = None,
+        gitignore_template: Optional[str] = None,
+        license_template: Optional[str] = None,
+        path: Optional[str] = None,
+        default_branch: Optional[str] = None,
+        **kwargs,
+    ) -> Repository:
+        return await self._model(
+            "POST",
+            self._client._path("orgs", org, "repos"),
+            Repository,
+            json={
+                "name": name,
+                "description": description,
+                "homepage": homepage,
+                "has_issues": has_issues,
+                "has_wiki": has_wiki,
+                "can_comment": can_comment,
+                "public": public,
+                "private": private,
+                "auto_init": auto_init,
+                "gitignore_template": gitignore_template,
+                "license_template": license_template,
+                "path": path,
+                "default_branch": default_branch,
+                **kwargs,
+            },
+        )
 
     async def get_enterprise_member(self, *, enterprise: str, username: str) -> EnterpriseMember:
         return await self._model(
@@ -415,8 +553,30 @@ class AsyncOrgsResource(AsyncResource, AbstractOrgsResource):
             json={"role": role},
         )
 
-    async def update(self, *, org: str, **payload) -> Organization:
-        return await self._model("PATCH", self._client._path("orgs", org), Organization, json=payload)
+    async def update(
+        self,
+        *,
+        org: str,
+        name: Optional[str] = None,
+        email: Optional[str] = None,
+        location: Optional[str] = None,
+        description: Optional[str] = None,
+        html_url: Optional[str] = None,
+        **kwargs,
+    ) -> Organization:
+        return await self._model(
+            "PATCH",
+            self._client._path("orgs", org),
+            Organization,
+            json={
+                "name": name,
+                "email": email,
+                "location": location,
+                "description": description,
+                "html_url": html_url,
+                **kwargs,
+            },
+        )
 
     async def leave(self, *, org: str) -> None:
         await self._request("DELETE", self._client._path("user", "memberships", "orgs", org))

gitcode_api/resources/collaboration/issues_resource_group.py

@@ -512,8 +512,8 @@ class IssuesResource(SyncResource, AbstractIssuesResource):
                 "milestone": milestone,
                 "security_hole": security_hole,
                 "template_path": template_path,
-            }
-            | kwargs,
+                **kwargs,
+            },
         )
 
     def update(
@@ -884,6 +884,7 @@ class AsyncIssuesResource(AsyncResource, AbstractIssuesResource):
                 "milestone": milestone,
                 "security_hole": security_hole,
                 "template_path": template_path,
+                **kwargs,
             },
         )
 

gitcode_api/resources/collaboration/pulls_resource_group.py

@@ -415,15 +415,21 @@ class AbstractPullsResource(ABC):
 
     @abstractmethod
     def request_test(
-        self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None, **payload
+        self,
+        *,
+        number: Union[int, str],
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        force: Optional[bool] = None,
+        **kwargs,
     ) -> None:
         """Request testing for a pull request.
 
         :param number: Pull request number.
         :param owner: Repository owner path. Uses the client default when omitted.
         :param repo: Repository path. Uses the client default when omitted.
-        :param payload: JSON fields required by the test request endpoint.
-        :returns: Test request result.
+        :param force: Force the test to pass (default ``False``), only effective for administrators.
+        :param kwargs: Additional arguments forwarded directly in request.
         """
 
     @abstractmethod
@@ -919,12 +925,18 @@ class PullsResource(SyncResource, AbstractPullsResource):
         return [as_model(item, PullRequestOperationLog) for item in data]
 
     def request_test(
-        self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None, **payload
+        self,
+        *,
+        number: Union[int, str],
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        force: Optional[bool] = None,
+        **kwargs,
     ) -> None:
         self._request(
             "POST",
             self._client._repo_path("pulls", number, "test", owner=owner, repo=repo),
-            json=payload,
+            json={"force": force, **kwargs},
         )
 
     def update_testers(
@@ -1375,12 +1387,18 @@ class AsyncPullsResource(AsyncResource, AbstractPullsResource):
         return [as_model(item, PullRequestOperationLog) for item in data]
 
     async def request_test(
-        self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None, **payload
+        self,
+        *,
+        number: Union[int, str],
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        force: Optional[bool] = None,
+        **kwargs,
     ) -> None:
         await self._request(
             "POST",
             self._client._repo_path("pulls", number, "test", owner=owner, repo=repo),
-            json=payload,
+            json={"force": force, **kwargs},
         )
 
     async def update_testers(

gitcode_api/resources/misc/releases_resource_group.py

@@ -4,6 +4,8 @@ from abc import ABC, abstractmethod
 from pathlib import Path
 from typing import List, Optional, Union
 
+import httpx
+
 from ..._models import Release, ReleaseUploadURL
 from .._shared import AsyncResource, SyncResource
 
@@ -83,7 +85,7 @@ class AbstractReleasesResource(ABC):
         owner: Optional[str] = None,
         repo: Optional[str] = None,
         upload_timeout: Optional[float] = 300.0,
-    ) -> None:
+    ) -> httpx.Response:
         """Upload a release attachment through the pre-signed upload URL.
 
         :param tag: Tag name in the release URL path.
@@ -92,6 +94,7 @@ class AbstractReleasesResource(ABC):
         :param owner: Repository owner path. Uses the client default when omitted.
         :param repo: Repository path. Uses the client default when omitted.
         :param upload_timeout: Timeout for upload operation. Default to 300 (5 minutes).
+        :returns: Response for upload put request (httpx.Response).
         """
 
     @abstractmethod
@@ -231,7 +234,7 @@ class ReleasesResource(SyncResource, AbstractReleasesResource):
         owner: Optional[str] = None,
         repo: Optional[str] = None,
         upload_timeout: Optional[float] = 300.0,
-    ) -> None:
+    ) -> httpx.Response:
         upload_content = Path(content).read_bytes() if isinstance(content, str) else content
         if not isinstance(upload_content, bytes):
             raise TypeError("content must be bytes or a file path string.")
@@ -240,7 +243,7 @@ class ReleasesResource(SyncResource, AbstractReleasesResource):
         if not upload_url.url:
             raise ValueError("Release upload URL response did not include a URL.")
 
-        self._client._client.request(
+        return self._client._client.request(
             "PUT",
             upload_url.url,
             content=upload_content,
@@ -372,7 +375,7 @@ class AsyncReleasesResource(AsyncResource, AbstractReleasesResource):
         owner: Optional[str] = None,
         repo: Optional[str] = None,
         upload_timeout: Optional[float] = 300.0,
-    ) -> None:
+    ) -> httpx.Response:
         upload_content = Path(content).read_bytes() if isinstance(content, str) else content
         if not isinstance(upload_content, bytes):
             raise TypeError("content must be bytes or a file path string.")
@@ -381,7 +384,7 @@ class AsyncReleasesResource(AsyncResource, AbstractReleasesResource):
         if not upload_url.url:
             raise ValueError("Release upload URL response did not include a URL.")
 
-        await self._client._client.request(
+        return await self._client._client.request(
             "PUT",
             upload_url.url,
             content=upload_content,

gitcode_api/resources/misc/webhooks_resource_group.py

@@ -32,13 +32,34 @@ class AbstractWebhooksResource(ABC):
         """
 
     @abstractmethod
-    def create(self, *, url: str, owner: Optional[str] = None, repo: Optional[str] = None, **payload) -> Webhook:
+    def create(
+        self,
+        *,
+        url: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        encryption_type: Optional[int] = None,
+        password: Optional[str] = None,
+        push_events: Optional[bool] = None,
+        tag_push_events: Optional[bool] = None,
+        issues_events: Optional[bool] = None,
+        note_events: Optional[bool] = None,
+        merge_requests_events: Optional[bool] = None,
+        **kwargs,
+    ) -> 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.).
+        :param encryption_type: Encryption type: ``0`` (password), ``1`` (signature key).
+        :param password: Secret included in requests to prevent malicious calls.
+        :param push_events: Trigger on push events.
+        :param tag_push_events: Trigger on tag push events.
+        :param issues_events: Trigger on issue creation/closure events.
+        :param note_events: Trigger on comment events (issue/PR/commit).
+        :param merge_requests_events: Trigger on merge request events.
+        :param kwargs: Additional arguments forwarded directly in request.
         :returns: Created webhook.
         """
 
@@ -60,15 +81,29 @@ class AbstractWebhooksResource(ABC):
         url: str,
         owner: Optional[str] = None,
         repo: Optional[str] = None,
-        **payload,
+        encryption_type: Optional[int] = None,
+        password: Optional[str] = None,
+        push_events: Optional[bool] = None,
+        tag_push_events: Optional[bool] = None,
+        issues_events: Optional[bool] = None,
+        note_events: Optional[bool] = None,
+        merge_requests_events: Optional[bool] = None,
+        **kwargs,
     ) -> Webhook:
         """Update a repository webhook.
 
         :param hook_id: Webhook id.
-        :param url: New payload URL (merged into the JSON body).
+        :param url: New 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: Other mutable webhook fields accepted by the API.
+        :param encryption_type: Encryption type: ``0`` (password), ``1`` (signature key).
+        :param password: Secret included in requests to prevent malicious calls.
+        :param push_events: Trigger on push events.
+        :param tag_push_events: Trigger on tag push events.
+        :param issues_events: Trigger on issue creation/closure events.
+        :param note_events: Trigger on comment events (issue/PR/commit).
+        :param merge_requests_events: Trigger on merge request events.
+        :param kwargs: Additional arguments forwarded directly in request.
         :returns: Updated webhook.
         """
 
@@ -109,9 +144,37 @@ class WebhooksResource(SyncResource, AbstractWebhooksResource):
             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 create(
+        self,
+        *,
+        url: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        encryption_type: Optional[int] = None,
+        password: Optional[str] = None,
+        push_events: Optional[bool] = None,
+        tag_push_events: Optional[bool] = None,
+        issues_events: Optional[bool] = None,
+        note_events: Optional[bool] = None,
+        merge_requests_events: Optional[bool] = None,
+        **kwargs,
+    ) -> Webhook:
+        return self._model(
+            "POST",
+            self._client._repo_path("hooks", owner=owner, repo=repo),
+            Webhook,
+            json={
+                "url": url,
+                "encryption_type": encryption_type,
+                "password": password,
+                "push_events": push_events,
+                "tag_push_events": tag_push_events,
+                "issues_events": issues_events,
+                "note_events": note_events,
+                "merge_requests_events": merge_requests_events,
+                **kwargs,
+            },
+        )
 
     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)
@@ -123,11 +186,30 @@ class WebhooksResource(SyncResource, AbstractWebhooksResource):
         url: str,
         owner: Optional[str] = None,
         repo: Optional[str] = None,
-        **payload,
+        encryption_type: Optional[int] = None,
+        password: Optional[str] = None,
+        push_events: Optional[bool] = None,
+        tag_push_events: Optional[bool] = None,
+        issues_events: Optional[bool] = None,
+        note_events: Optional[bool] = None,
+        merge_requests_events: Optional[bool] = None,
+        **kwargs,
     ) -> Webhook:
-        payload["url"] = url
         return self._model(
-            "PATCH", self._client._repo_path("hooks", hook_id, owner=owner, repo=repo), Webhook, json=payload
+            "PATCH",
+            self._client._repo_path("hooks", hook_id, owner=owner, repo=repo),
+            Webhook,
+            json={
+                "url": url,
+                "encryption_type": encryption_type,
+                "password": password,
+                "push_events": push_events,
+                "tag_push_events": tag_push_events,
+                "issues_events": issues_events,
+                "note_events": note_events,
+                "merge_requests_events": merge_requests_events,
+                **kwargs,
+            },
         )
 
     def delete(self, *, hook_id: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> None:
@@ -158,10 +240,36 @@ class AsyncWebhooksResource(AsyncResource, AbstractWebhooksResource):
             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
+    async def create(
+        self,
+        *,
+        url: str,
+        owner: Optional[str] = None,
+        repo: Optional[str] = None,
+        encryption_type: Optional[int] = None,
+        password: Optional[str] = None,
+        push_events: Optional[bool] = None,
+        tag_push_events: Optional[bool] = None,
+        issues_events: Optional[bool] = None,
+        note_events: Optional[bool] = None,
+        merge_requests_events: Optional[bool] = None,
+        **kwargs,
+    ) -> Webhook:
         return await self._model(
-            "POST", self._client._repo_path("hooks", owner=owner, repo=repo), Webhook, json=payload
+            "POST",
+            self._client._repo_path("hooks", owner=owner, repo=repo),
+            Webhook,
+            json={
+                "url": url,
+                "encryption_type": encryption_type,
+                "password": password,
+                "push_events": push_events,
+                "tag_push_events": tag_push_events,
+                "issues_events": issues_events,
+                "note_events": note_events,
+                "merge_requests_events": merge_requests_events,
+                **kwargs,
+            },
         )
 
     async def get(
@@ -176,11 +284,30 @@ class AsyncWebhooksResource(AsyncResource, AbstractWebhooksResource):
         url: str,
         owner: Optional[str] = None,
         repo: Optional[str] = None,
-        **payload,
+        encryption_type: Optional[int] = None,
+        password: Optional[str] = None,
+        push_events: Optional[bool] = None,
+        tag_push_events: Optional[bool] = None,
+        issues_events: Optional[bool] = None,
+        note_events: Optional[bool] = None,
+        merge_requests_events: Optional[bool] = None,
+        **kwargs,
     ) -> Webhook:
-        payload["url"] = url
         return await self._model(
-            "PATCH", self._client._repo_path("hooks", hook_id, owner=owner, repo=repo), Webhook, json=payload
+            "PATCH",
+            self._client._repo_path("hooks", hook_id, owner=owner, repo=repo),
+            Webhook,
+            json={
+                "url": url,
+                "encryption_type": encryption_type,
+                "password": password,
+                "push_events": push_events,
+                "tag_push_events": tag_push_events,
+                "issues_events": issues_events,
+                "note_events": note_events,
+                "merge_requests_events": merge_requests_events,
+                **kwargs,
+            },
         )
 
     async def delete(