archastro.platform.v1.resources.team_memberships

  1# Copyright (c) 2026 ArchAstro Inc. All Rights Reserved.
  2# This file is auto-generated by @archastro/sdk-generator. Do not edit.
  3# Content hash: 286483c03131
  4
  5from __future__ import annotations
  6
  7import builtins
  8
  9from ...runtime.http_client import HttpClient, SyncHttpClient
 10from ...types.teams import TeamMembershipListResponse
 11
 12
 13class AsyncTeamMembershipResource:
 14    def __init__(self, http: HttpClient):
 15        self._http = http
 16
 17    async def list(
 18        self,
 19        *,
 20        team: builtins.list[str] | None = None,
 21        user: builtins.list[str] | None = None,
 22        agent: builtins.list[str] | None = None,
 23        page: int | None = None,
 24        page_size: int | None = None,
 25    ) -> TeamMembershipListResponse:
 26        """
 27        List team memberships
 28        Returns a paginated list of team memberships across all teams accessible to
 29        the authenticated caller. Use the `team`, `user`, and `agent` filters to
 30        narrow results to a specific team or principal.
 31        This endpoint requires S2S (service-to-service) authentication. Callers
 32        authenticated with a user token receive a 401. Each membership includes the
 33        resolved `type` (`"user"`, `"agent"`, or `"unknown"`), display name, and
 34        profile picture derived from the associated user or agent at request time.
 35        Results are returned in offset-based pages. Pass `page` and `page_size` to
 36        navigate; the response includes `has_next` and `has_prev` to determine
 37        whether adjacent pages exist.
 38
 39        Args:
 40            team: Filter results to memberships belonging to these team IDs (`tm_...`). Multiple values are combined with OR.
 41            user: Filter results to memberships held by these user IDs (`usr_...`). Multiple values are combined with OR.
 42            agent: Filter results to memberships held by these agent IDs (`agt_...`). Multiple values are combined with OR.
 43            page: Page number to retrieve, starting at `1`. Defaults to `1`.
 44            page_size: Number of memberships to return per page. Defaults to `25`.
 45
 46        Returns:
 47            Paginated list of team memberships matching the applied filters.
 48        """
 49        query: dict[str, object] = {}
 50        if team is not None:
 51            query["team"] = team
 52        if user is not None:
 53            query["user"] = user
 54        if agent is not None:
 55            query["agent"] = agent
 56        if page is not None:
 57            query["page"] = page
 58        if page_size is not None:
 59            query["page_size"] = page_size
 60        return await self._http.request(
 61            "/api/v1/team_memberships",
 62            query=query,
 63            response_type=TeamMembershipListResponse,
 64        )
 65
 66    async def delete(self, team_membership: str) -> None:
 67        """
 68        Remove a team membership by ID
 69        Removes a team membership identified directly by its membership ID. On
 70        success, returns 204 No Content.
 71        This endpoint is intended for server-to-server callers that already hold the
 72        membership ID. To remove a member by user or agent ID instead, use the team
 73        members delete endpoint. The caller must have permission to manage the team
 74        that the membership belongs to.
 75
 76        Args:
 77            team_membership: Team membership ID (`tmb_...`) to remove. The membership must be within the caller's app scope.
 78
 79        Returns:
 80            Empty response. Returns 204 No Content on success.
 81        """
 82        await self._http.request(f"/api/v1/team_memberships/{team_membership}", method="DELETE")
 83
 84
 85class TeamMembershipResource:
 86    def __init__(self, http: SyncHttpClient):
 87        self._http = http
 88
 89    def list(
 90        self,
 91        *,
 92        team: builtins.list[str] | None = None,
 93        user: builtins.list[str] | None = None,
 94        agent: builtins.list[str] | None = None,
 95        page: int | None = None,
 96        page_size: int | None = None,
 97    ) -> TeamMembershipListResponse:
 98        """
 99        List team memberships
100        Returns a paginated list of team memberships across all teams accessible to
101        the authenticated caller. Use the `team`, `user`, and `agent` filters to
102        narrow results to a specific team or principal.
103        This endpoint requires S2S (service-to-service) authentication. Callers
104        authenticated with a user token receive a 401. Each membership includes the
105        resolved `type` (`"user"`, `"agent"`, or `"unknown"`), display name, and
106        profile picture derived from the associated user or agent at request time.
107        Results are returned in offset-based pages. Pass `page` and `page_size` to
108        navigate; the response includes `has_next` and `has_prev` to determine
109        whether adjacent pages exist.
110
111        Args:
112            team: Filter results to memberships belonging to these team IDs (`tm_...`). Multiple values are combined with OR.
113            user: Filter results to memberships held by these user IDs (`usr_...`). Multiple values are combined with OR.
114            agent: Filter results to memberships held by these agent IDs (`agt_...`). Multiple values are combined with OR.
115            page: Page number to retrieve, starting at `1`. Defaults to `1`.
116            page_size: Number of memberships to return per page. Defaults to `25`.
117
118        Returns:
119            Paginated list of team memberships matching the applied filters.
120        """
121        query: dict[str, object] = {}
122        if team is not None:
123            query["team"] = team
124        if user is not None:
125            query["user"] = user
126        if agent is not None:
127            query["agent"] = agent
128        if page is not None:
129            query["page"] = page
130        if page_size is not None:
131            query["page_size"] = page_size
132        return self._http.request(
133            "/api/v1/team_memberships",
134            query=query,
135            response_type=TeamMembershipListResponse,
136        )
137
138    def delete(self, team_membership: str) -> None:
139        """
140        Remove a team membership by ID
141        Removes a team membership identified directly by its membership ID. On
142        success, returns 204 No Content.
143        This endpoint is intended for server-to-server callers that already hold the
144        membership ID. To remove a member by user or agent ID instead, use the team
145        members delete endpoint. The caller must have permission to manage the team
146        that the membership belongs to.
147
148        Args:
149            team_membership: Team membership ID (`tmb_...`) to remove. The membership must be within the caller's app scope.
150
151        Returns:
152            Empty response. Returns 204 No Content on success.
153        """
154        self._http.request(f"/api/v1/team_memberships/{team_membership}", method="DELETE")