archastro.platform.types.teams

  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: fcfcac9428bf
  4
  5from datetime import datetime
  6from typing import Any
  7
  8from pydantic import BaseModel, Field
  9
 10from .common import Acl, Agent
 11from .image import ImageSource
 12from .users import User
 13
 14
 15class Team(BaseModel):
 16    """
 17    A team within an organization, used to group users and agents and scope resources like configs, agents, and tasks.
 18    """
 19
 20    acl: Acl | None = Field(
 21        default=None,
 22        description="Access control list governing visibility and join permissions for this team. `null` when no ACL restrictions are applied and the team inherits default access rules.",
 23    )
 24    app: str | None = Field(
 25        default=None,
 26        description="ID of the developer application this team belongs to (`dap_...`). `null` if the team is not scoped to an app.",
 27    )
 28    badges: dict[str, Any] | None = Field(
 29        default=None,
 30        description="Aggregated badge counts for the team, keyed by category. `null` when badge data is not loaded.",
 31    )
 32    created_at: datetime | None = Field(
 33        default=None, description="When this team was created (ISO 8601)."
 34    )
 35    description: str | None = Field(
 36        default=None,
 37        description="Human-readable description of the team's purpose. `null` if not set.",
 38    )
 39    id: str = Field(..., description="Team ID (`tem_...`).")
 40    membership_status: str | None = Field(
 41        default=None,
 42        description='The authenticated viewer\'s role on this team. One of `"owner"`, `"admin"`, or `"member"`. `null` if the viewer is not a member.',
 43    )
 44    metadata: dict[str, Any] | None = Field(
 45        default=None,
 46        description="Arbitrary key-value metadata attached to this team. Returns an empty object when no metadata has been set.",
 47    )
 48    name: str | None = Field(default=None, description="Display name of the team.")
 49    org: str | None = Field(
 50        default=None,
 51        description="ID of the organization this team belongs to (`org_...`). `null` if the team is not org-scoped.",
 52    )
 53    sandbox: str | None = Field(
 54        default=None,
 55        description="ID of the developer sandbox this team is scoped to (`dsb_...`). `null` outside sandbox contexts.",
 56    )
 57    slug: str | None = Field(
 58        default=None,
 59        description="URL-safe slug for the team, derived from the team name. `null` if not set.",
 60    )
 61    updated_at: datetime | None = Field(
 62        default=None, description="When this team was last updated (ISO 8601)."
 63    )
 64
 65
 66class TeamInvite(BaseModel):
 67    """
 68    A team invite containing a short alphanumeric code that other users can present to join the team.
 69    """
 70
 71    code: str = Field(
 72        ...,
 73        description="Short alphanumeric join code. Pass this value as `join_code` to the join-with-code endpoint to add a user to the team.",
 74    )
 75
 76
 77class TeamMembership(BaseModel):
 78    """
 79    A record representing a user's or agent's membership in a team, including their resolved identity details and role.
 80    """
 81
 82    agent: Agent | None = Field(
 83        default=None,
 84        description="The agent associated with this membership, as an expanded agent object. `null` when the member is a user, the type is unknown, or the association is not preloaded.",
 85    )
 86    created_at: datetime | None = Field(
 87        default=None, description="When this membership record was created (ISO 8601)."
 88    )
 89    id: str = Field(..., description="Team membership ID (`tmb_...`).")
 90    joined_at: datetime | None = Field(
 91        default=None, description="When the principal joined the team (ISO 8601)."
 92    )
 93    metadata: dict[str, Any] | None = Field(
 94        default=None,
 95        description="Arbitrary key-value metadata attached to this membership record. `null` if no metadata has been set.",
 96    )
 97    name: str | None = Field(
 98        default=None,
 99        description="Display name of the member, derived from the associated user or agent. `null` if the principal is unknown.",
100    )
101    profile_picture: ImageSource | None = Field(
102        default=None,
103        description="Profile picture of the member, derived from the associated user or agent. `null` if not set or principal is unknown.",
104    )
105    role: str | None = Field(
106        default=None,
107        description='The member\'s role within the team. One of `"owner"`, `"admin"`, or `"member"`.',
108    )
109    team: dict[str, Any] | None = Field(
110        default=None,
111        description="The team this membership belongs to, as an expanded team object. `null` when the team association is not preloaded.",
112    )
113    type: str | None = Field(
114        default=None,
115        description='Resolved principal type. One of `"user"`, `"agent"`, or `"unknown"` when the principal cannot be determined.',
116    )
117    updated_at: datetime | None = Field(
118        default=None, description="When this membership record was last updated (ISO 8601)."
119    )
120    user: User | None = Field(
121        default=None,
122        description="The user associated with this membership, as an expanded user object. `null` when the member is an agent, the type is unknown, or the association is not preloaded.",
123    )
124
125
126class TeamMembershipListResponse(BaseModel):
127    """
128    A paginated list of team memberships returned by the list team memberships endpoint.
129    """
130
131    data: list[TeamMembership] = Field(
132        ..., description="Array of team membership objects for the current page."
133    )
134    has_next: bool | None = Field(
135        default=None,
136        description="`true` if a subsequent page exists; `false` when this is the last page.",
137    )
138    has_prev: bool | None = Field(
139        default=None,
140        description="`true` if a previous page exists; `false` when this is the first page.",
141    )
142    page: int | None = Field(default=None, description="Current page number, starting at `1`.")
143    page_size: int | None = Field(
144        default=None, description="Maximum number of results returned per page."
145    )
146    total_entries: int | None = Field(
147        default=None,
148        description="Total number of team memberships matching the applied filters across all pages.",
149    )
150    total_pages: int | None = Field(
151        default=None, description="Total number of pages given the current `page_size`."
152    )