Teams

albert.resources.teams

Attributes:

Name	Type	Description
`TeamRole`

TeamRole

TeamRole = Literal['TeamOwner', 'TeamViewer']

TeamMember

Bases: BaseAlbertModel

A user belonging to a team.

Attributes:

Name	Type	Description
`id`	`str`	The Albert user ID.
`name`	`str \| None`	The display name of the user.
`role`	`TeamRole \| None`	The team role. Must be `"TeamOwner"` or `"TeamViewer"`.

Show JSON schema:

{
  "description": "A user belonging to a team.\n\nAttributes\n----------\nid : str\n    The Albert user ID.\nname : str | None\n    The display name of the user.\nrole : TeamRole | None\n    The team role. Must be ``\"TeamOwner\"`` or ``\"TeamViewer\"``.",
  "properties": {
    "id": {
      "title": "Id",
      "type": "string"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "fgc": {
      "anyOf": [
        {
          "enum": [
            "TeamOwner",
            "TeamViewer"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Fgc"
    }
  },
  "required": [
    "id"
  ],
  "title": "TeamMember",
  "type": "object"
}

Fields:

id (UserId)
name (str | None)
role (TeamRole | None)

id

id: UserId

name

name: str | None = None

role

role: TeamRole | None = None

Team

Bases: BaseResource

Represents a Team on the Albert Platform.

Attributes:

Name	Type	Description
`id`	`str \| None`	The Albert ID of the team. Set when the team is retrieved from Albert.
`name`	`str`	The name of the team.
`members`	`list[TeamMember] \| None`	The members of the team with their names and roles.

id

id: TeamId | None = Field(default=None, alias='albertId')

name

name: str = Field(min_length=1)

members

members: list[TeamMember] | None = Field(
    default=None, alias="Users"
)