teams

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

SyncAsync

OrgsTeams

The orgs.teams namespace.

create

create(
    org: str,
    *,
    can_create_org_repo: bool | None = None,
    description: str | None = None,
    includes_all_repositories: bool | None = None,
    name: str,
    permission: CreateTeamOptionPermission | None = None,
    units: list[str] | None = None,
    units_map: dict[str, str] | None = None,
) -> Team

Create a team.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`can_create_org_repo`	`bool \| None`		`None`
`description`	`str \| None`		`None`
`includes_all_repositories`	`bool \| None`		`None`
`name`	`str`		required
`permission`	`CreateTeamOptionPermission \| 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.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: orgCreateTeam

list

list(org: str, *, page: int | None = None, limit: int | None = None) -> Paginated[Team]

List an organization's teams.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`Paginated[Team]`	TeamList.

Raises:

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

Operation ID: orgListTeams

search

search(
    org: str,
    *,
    q: str | None = None,
    include_desc: bool | None = None,
    page: int | None = None,
    limit: int | None = None,
) -> TeamSearchResults

Search for teams within an organization.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`q`	`str \| None`	keywords to search	`None`
`include_desc`	`bool \| None`	include search within team description (defaults to true)	`None`
`page`	`int \| None`	page number of results to return (1-based)	`None`
`limit`	`int \| None`	page size of results	`None`

Returns:

Type	Description
`TeamSearchResults`	SearchResults of a successful search.

Raises:

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

Operation ID: teamSearch

AsyncOrgsTeams

The orgs.teams namespace.

create

create(
    org: str,
    *,
    can_create_org_repo: bool | None = None,
    description: str | None = None,
    includes_all_repositories: bool | None = None,
    name: str,
    permission: CreateTeamOptionPermission | None = None,
    units: list[str] | None = None,
    units_map: dict[str, str] | None = None,
) -> Team

Create a team.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`can_create_org_repo`	`bool \| None`		`None`
`description`	`str \| None`		`None`
`includes_all_repositories`	`bool \| None`		`None`
`name`	`str`		required
`permission`	`CreateTeamOptionPermission \| 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.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: orgCreateTeam

list

list(org: str, *, page: int | None = None, limit: int | None = None) -> AsyncPaginated[Team]

List an organization's teams.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`AsyncPaginated[Team]`	TeamList.

Raises:

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

Operation ID: orgListTeams

search

search(
    org: str,
    *,
    q: str | None = None,
    include_desc: bool | None = None,
    page: int | None = None,
    limit: int | None = None,
) -> TeamSearchResults

Search for teams within an organization.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`q`	`str \| None`	keywords to search	`None`
`include_desc`	`bool \| None`	include search within team description (defaults to true)	`None`
`page`	`int \| None`	page number of results to return (1-based)	`None`
`limit`	`int \| None`	page size of results	`None`

Returns:

Type	Description
`TeamSearchResults`	SearchResults of a successful search.

Raises:

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

Operation ID: teamSearch