teams

Accessed as client.teams; the async client mirrors it.

SyncAsync

Teams

The teams namespace.

activities

activities: TeamsActivities = TeamsActivities(client)

members

members: TeamsMembers = TeamsMembers(client)

repos

repos: TeamsRepos = TeamsRepos(client)

delete

delete(id: int) -> None

Delete a team.

Parameters:

Name	Type	Description	Default
`id`	`int`	id of the team to delete	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgDeleteTeam

get

get(id: int) -> Team

Get a team.

Parameters:

Name	Type	Description	Default
`id`	`int`	id of the team to get	required

Returns:

Type	Description
`Team`	Team.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgGetTeam

update

update(
    id: int,
    *,
    can_create_org_repo: bool | None = None,
    description: str | None = None,
    includes_all_repositories: bool | None = None,
    name: str,
    permission: EditTeamOptionPermission | None = None,
    units: list[str] | None = None,
    units_map: dict[str, str] | None = None,
) -> Team

Edit a team.

Parameters:

Name	Type	Description	Default
`id`	`int`	id of the team to edit	required
`can_create_org_repo`	`bool \| None`		`None`
`description`	`str \| None`		`None`
`includes_all_repositories`	`bool \| None`		`None`
`name`	`str`		required
`permission`	`EditTeamOptionPermission \| None`		`None`
`units`	`list[str] \| None`		`None`
`units_map`	`dict[str, str] \| None`		`None`

Returns:

Type	Description
`Team`	Team.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgEditTeam

AsyncTeams

The teams namespace.

activities

activities: AsyncTeamsActivities = AsyncTeamsActivities(client)

members

members: AsyncTeamsMembers = AsyncTeamsMembers(client)

repos

repos: AsyncTeamsRepos = AsyncTeamsRepos(client)

delete

delete(id: int) -> None

Delete a team.

Parameters:

Name	Type	Description	Default
`id`	`int`	id of the team to delete	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgDeleteTeam

get

get(id: int) -> Team

Get a team.

Parameters:

Name	Type	Description	Default
`id`	`int`	id of the team to get	required

Returns:

Type	Description
`Team`	Team.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgGetTeam

update

update(
    id: int,
    *,
    can_create_org_repo: bool | None = None,
    description: str | None = None,
    includes_all_repositories: bool | None = None,
    name: str,
    permission: EditTeamOptionPermission | None = None,
    units: list[str] | None = None,
    units_map: dict[str, str] | None = None,
) -> Team

Edit a team.

Parameters:

Name	Type	Description	Default
`id`	`int`	id of the team to edit	required
`can_create_org_repo`	`bool \| None`		`None`
`description`	`str \| None`		`None`
`includes_all_repositories`	`bool \| None`		`None`
`name`	`str`		required
`permission`	`EditTeamOptionPermission \| None`		`None`
`units`	`list[str] \| None`		`None`
`units_map`	`dict[str, str] \| None`		`None`

Returns:

Type	Description
`Team`	Team.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgEditTeam