feat(api): add pagination and query parameter to runners.list_scm_organizations

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 193
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-2e21ce480356fd18cc413421d9d85ef46d7ebd7961518933cfb5b469799c57d7.yml
-openapi_spec_hash: f558f68f695c3c21bf10252e3505fdf1
-config_hash: 52dce9b7b86eca30b5b126335592f962
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-162fdc304a6f1f8e282b49c7cde2e2aa282e58045ac814869491340f932982d4.yml
+openapi_spec_hash: 017607fc78184b5a49249ed134e1ad7c
+config_hash: 4447d1e1149a80d1bec70d353fb8acbf

api.md

@@ -710,7 +710,7 @@ Methods:
 - <code title="post /gitpod.v1.RunnerService/CheckRepositoryAccess">client.runners.<a href="./src/gitpod/resources/runners/runners.py">check_repository_access</a>(\*\*<a href="src/gitpod/types/runner_check_repository_access_params.py">params</a>) -> <a href="./src/gitpod/types/runner_check_repository_access_response.py">RunnerCheckRepositoryAccessResponse</a></code>
 - <code title="post /gitpod.v1.RunnerService/CreateRunnerLogsToken">client.runners.<a href="./src/gitpod/resources/runners/runners.py">create_logs_token</a>(\*\*<a href="src/gitpod/types/runner_create_logs_token_params.py">params</a>) -> <a href="./src/gitpod/types/runner_create_logs_token_response.py">RunnerCreateLogsTokenResponse</a></code>
 - <code title="post /gitpod.v1.RunnerService/CreateRunnerToken">client.runners.<a href="./src/gitpod/resources/runners/runners.py">create_runner_token</a>(\*\*<a href="src/gitpod/types/runner_create_runner_token_params.py">params</a>) -> <a href="./src/gitpod/types/runner_create_runner_token_response.py">RunnerCreateRunnerTokenResponse</a></code>
-- <code title="post /gitpod.v1.RunnerService/ListSCMOrganizations">client.runners.<a href="./src/gitpod/resources/runners/runners.py">list_scm_organizations</a>(\*\*<a href="src/gitpod/types/runner_list_scm_organizations_params.py">params</a>) -> <a href="./src/gitpod/types/runner_list_scm_organizations_response.py">RunnerListScmOrganizationsResponse</a></code>
+- <code title="post /gitpod.v1.RunnerService/ListSCMOrganizations">client.runners.<a href="./src/gitpod/resources/runners/runners.py">list_scm_organizations</a>(\*\*<a href="src/gitpod/types/runner_list_scm_organizations_params.py">params</a>) -> <a href="./src/gitpod/types/runner_list_scm_organizations_response.py">SyncOrganizationsPage[RunnerListScmOrganizationsResponse]</a></code>
 - <code title="post /gitpod.v1.RunnerService/ParseContextURL">client.runners.<a href="./src/gitpod/resources/runners/runners.py">parse_context_url</a>(\*\*<a href="src/gitpod/types/runner_parse_context_url_params.py">params</a>) -> <a href="./src/gitpod/types/runner_parse_context_url_response.py">RunnerParseContextURLResponse</a></code>
 - <code title="post /gitpod.v1.RunnerService/SearchRepositories">client.runners.<a href="./src/gitpod/resources/runners/runners.py">search_repositories</a>(\*\*<a href="src/gitpod/types/runner_search_repositories_params.py">params</a>) -> <a href="./src/gitpod/types/runner_search_repositories_response.py">RunnerSearchRepositoriesResponse</a></code>
 

src/gitpod/pagination.py

@@ -51,6 +51,9 @@
     "MembersPagePagination",
     "SyncMembersPage",
     "AsyncMembersPage",
+    "OrganizationsPagePagination",
+    "SyncOrganizationsPage",
+    "AsyncOrganizationsPage",
     "OutputsPagePagination",
     "SyncOutputsPage",
     "AsyncOutputsPage",
@@ -819,6 +822,56 @@ def next_page_info(self) -> Optional[PageInfo]:
         return PageInfo(params={"token": next_token})
 
 
+class OrganizationsPagePagination(BaseModel):
+    next_token: Optional[str] = FieldInfo(alias="nextToken", default=None)
+
+
+class SyncOrganizationsPage(BaseSyncPage[_T], BasePage[_T], Generic[_T]):
+    organizations: List[_T]
+    pagination: Optional[OrganizationsPagePagination] = None
+
+    @override
+    def _get_page_items(self) -> List[_T]:
+        organizations = self.organizations
+        if not organizations:
+            return []
+        return organizations
+
+    @override
+    def next_page_info(self) -> Optional[PageInfo]:
+        next_token = None
+        if self.pagination is not None:
+            if self.pagination.next_token is not None:
+                next_token = self.pagination.next_token
+        if not next_token:
+            return None
+
+        return PageInfo(params={"token": next_token})
+
+
+class AsyncOrganizationsPage(BaseAsyncPage[_T], BasePage[_T], Generic[_T]):
+    organizations: List[_T]
+    pagination: Optional[OrganizationsPagePagination] = None
+
+    @override
+    def _get_page_items(self) -> List[_T]:
+        organizations = self.organizations
+        if not organizations:
+            return []
+        return organizations
+
+    @override
+    def next_page_info(self) -> Optional[PageInfo]:
+        next_token = None
+        if self.pagination is not None:
+            if self.pagination.next_token is not None:
+                next_token = self.pagination.next_token
+        if not next_token:
+            return None
+
+        return PageInfo(params={"token": next_token})
+
+
 class OutputsPagePagination(BaseModel):
     next_token: Optional[str] = FieldInfo(alias="nextToken", default=None)
 

src/gitpod/resources/runners/runners.py

@@ -41,7 +41,7 @@
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
-from ...pagination import SyncRunnersPage, AsyncRunnersPage
+from ...pagination import SyncRunnersPage, AsyncRunnersPage, SyncOrganizationsPage, AsyncOrganizationsPage
 from ..._base_client import AsyncPaginator, make_request_options
 from ...types.runner import Runner
 from ...types.runner_kind import RunnerKind
@@ -681,6 +681,8 @@ def list_scm_organizations(
         *,
         token: str | Omit = omit,
         page_size: int | Omit = omit,
+        pagination: runner_list_scm_organizations_params.Pagination | Omit = omit,
+        query: str | Omit = omit,
         runner_id: str | Omit = omit,
         scm_host: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -689,7 +691,7 @@ def list_scm_organizations(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> RunnerListScmOrganizationsResponse:
+    ) -> SyncOrganizationsPage[RunnerListScmOrganizationsResponse]:
         """
         Lists SCM organizations the user belongs to.
 
@@ -709,7 +711,29 @@ def list_scm_organizations(
           scmHost: "github.com"
           ```
 
+        - Search GitLab groups:
+
+          Returns the first page of GitLab groups matching the substring.
+
+          ```yaml
+          runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
+          scmHost: "gitlab.com"
+          query: "platform"
+          pagination:
+            pageSize: 25
+          ```
+
         Args:
+          pagination: Pagination parameters. When unset, defaults to the standard PaginationRequest
+              defaults (page_size 25, max 100). Tokens are opaque and provider-specific.
+
+          query: Optional substring filter applied to the organization name.
+
+              - GitLab: forwarded to the upstream `search` parameter (server-side,
+                case-insensitive substring on name/path).
+              - GitHub and Bitbucket: not implemented as they don't support searching Empty
+                value means no filter.
+
           scm_host: The SCM host to list organizations from (e.g., "github.com", "gitlab.com")
 
           extra_headers: Send extra headers
@@ -720,10 +744,13 @@ def list_scm_organizations(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return self._post(
+        return self._get_api_list(
             "/gitpod.v1.RunnerService/ListSCMOrganizations",
+            page=SyncOrganizationsPage[RunnerListScmOrganizationsResponse],
             body=maybe_transform(
                 {
+                    "pagination": pagination,
+                    "query": query,
                     "runner_id": runner_id,
                     "scm_host": scm_host,
                 },
@@ -742,7 +769,8 @@ def list_scm_organizations(
                     runner_list_scm_organizations_params.RunnerListScmOrganizationsParams,
                 ),
             ),
-            cast_to=RunnerListScmOrganizationsResponse,
+            model=RunnerListScmOrganizationsResponse,
+            method="post",
         )
 
     def parse_context_url(
@@ -1505,11 +1533,13 @@ async def create_runner_token(
             cast_to=RunnerCreateRunnerTokenResponse,
         )
 
-    async def list_scm_organizations(
+    def list_scm_organizations(
         self,
         *,
         token: str | Omit = omit,
         page_size: int | Omit = omit,
+        pagination: runner_list_scm_organizations_params.Pagination | Omit = omit,
+        query: str | Omit = omit,
         runner_id: str | Omit = omit,
         scm_host: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -1518,7 +1548,7 @@ async def list_scm_organizations(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> RunnerListScmOrganizationsResponse:
+    ) -> AsyncPaginator[RunnerListScmOrganizationsResponse, AsyncOrganizationsPage[RunnerListScmOrganizationsResponse]]:
         """
         Lists SCM organizations the user belongs to.
 
@@ -1538,7 +1568,29 @@ async def list_scm_organizations(
           scmHost: "github.com"
           ```
 
+        - Search GitLab groups:
+
+          Returns the first page of GitLab groups matching the substring.
+
+          ```yaml
+          runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
+          scmHost: "gitlab.com"
+          query: "platform"
+          pagination:
+            pageSize: 25
+          ```
+
         Args:
+          pagination: Pagination parameters. When unset, defaults to the standard PaginationRequest
+              defaults (page_size 25, max 100). Tokens are opaque and provider-specific.
+
+          query: Optional substring filter applied to the organization name.
+
+              - GitLab: forwarded to the upstream `search` parameter (server-side,
+                case-insensitive substring on name/path).
+              - GitHub and Bitbucket: not implemented as they don't support searching Empty
+                value means no filter.
+
           scm_host: The SCM host to list organizations from (e.g., "github.com", "gitlab.com")
 
           extra_headers: Send extra headers
@@ -1549,10 +1601,13 @@ async def list_scm_organizations(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return await self._post(
+        return self._get_api_list(
             "/gitpod.v1.RunnerService/ListSCMOrganizations",
-            body=await async_maybe_transform(
+            page=AsyncOrganizationsPage[RunnerListScmOrganizationsResponse],
+            body=maybe_transform(
                 {
+                    "pagination": pagination,
+                    "query": query,
                     "runner_id": runner_id,
                     "scm_host": scm_host,
                 },
@@ -1563,15 +1618,16 @@ async def list_scm_organizations(
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=await async_maybe_transform(
+                query=maybe_transform(
                     {
                         "token": token,
                         "page_size": page_size,
                     },
                     runner_list_scm_organizations_params.RunnerListScmOrganizationsParams,
                 ),
             ),
-            cast_to=RunnerListScmOrganizationsResponse,
+            model=RunnerListScmOrganizationsResponse,
+            method="post",
         )
 
     async def parse_context_url(

src/gitpod/types/runner_list_scm_organizations_params.py

@@ -6,15 +6,51 @@
 
 from .._utils import PropertyInfo
 
-__all__ = ["RunnerListScmOrganizationsParams"]
+__all__ = ["RunnerListScmOrganizationsParams", "Pagination"]
 
 
 class RunnerListScmOrganizationsParams(TypedDict, total=False):
     token: str
 
     page_size: Annotated[int, PropertyInfo(alias="pageSize")]
 
+    pagination: Pagination
+    """Pagination parameters.
+
+    When unset, defaults to the standard PaginationRequest defaults (page_size 25,
+    max 100). Tokens are opaque and provider-specific.
+    """
+
+    query: str
+    """Optional substring filter applied to the organization name.
+
+    - GitLab: forwarded to the upstream `search` parameter (server-side,
+      case-insensitive substring on name/path).
+    - GitHub and Bitbucket: not implemented as they don't support searching Empty
+      value means no filter.
+    """
+
     runner_id: Annotated[str, PropertyInfo(alias="runnerId")]
 
     scm_host: Annotated[str, PropertyInfo(alias="scmHost")]
     """The SCM host to list organizations from (e.g., "github.com", "gitlab.com")"""
+
+
+class Pagination(TypedDict, total=False):
+    """Pagination parameters.
+
+    When unset, defaults to the standard PaginationRequest defaults
+     (page_size 25, max 100). Tokens are opaque and provider-specific.
+    """
+
+    token: str
+    """
+    Token for the next set of results that was returned as next_token of a
+    PaginationResponse
+    """
+
+    page_size: Annotated[int, PropertyInfo(alias="pageSize")]
+    """Page size is the maximum number of results to retrieve per page. Defaults to 25.
+
+    Maximum 100.
+    """

src/gitpod/types/runner_list_scm_organizations_response.py

@@ -1,15 +1,15 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List, Optional
+from typing import Optional
 
 from pydantic import Field as FieldInfo
 
 from .._models import BaseModel
 
-__all__ = ["RunnerListScmOrganizationsResponse", "Organization"]
+__all__ = ["RunnerListScmOrganizationsResponse"]
 
 
-class Organization(BaseModel):
+class RunnerListScmOrganizationsResponse(BaseModel):
     is_admin: Optional[bool] = FieldInfo(alias="isAdmin", default=None)
     """
     Deprecated: this field is unused by all known consumers and is scheduled for
@@ -26,8 +26,3 @@ class Organization(BaseModel):
 
     url: Optional[str] = None
     """Organization URL (e.g., "https://github.com/gitpod-io")"""
-
-
-class RunnerListScmOrganizationsResponse(BaseModel):
-    organizations: Optional[List[Organization]] = None
-    """List of organizations the user belongs to"""