members
Accessed as client.teams.members; the async client mirrors it.
TeamsMembers
The teams.members namespace.
add
add(id: int, username: str) -> None
Add a team member.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
int
|
id of the team |
required |
username
|
str
|
username of the user to add |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: orgAddTeamMember
get
get(id: int, username: str) -> User
List a particular member of team.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
int
|
id of the team |
required |
username
|
str
|
username of the member to list |
required |
Returns:
| Type | Description |
|---|---|
User
|
User. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: orgListTeamMember
list
List a team's members.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
int
|
id of the team |
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[User]
|
UserList. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: orgListTeamMembers
remove
remove(id: int, username: str) -> None
Remove a team member.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
int
|
id of the team |
required |
username
|
str
|
username of the user to remove |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: orgRemoveTeamMember
AsyncTeamsMembers
The teams.members namespace.
add
add(id: int, username: str) -> None
Add a team member.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
int
|
id of the team |
required |
username
|
str
|
username of the user to add |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: orgAddTeamMember
get
get(id: int, username: str) -> User
List a particular member of team.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
int
|
id of the team |
required |
username
|
str
|
username of the member to list |
required |
Returns:
| Type | Description |
|---|---|
User
|
User. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: orgListTeamMember
list
list(id: int, *, page: int | None = None, limit: int | None = None) -> AsyncPaginated[User]
List a team's members.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
int
|
id of the team |
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[User]
|
UserList. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: orgListTeamMembers
remove
remove(id: int, username: str) -> None
Remove a team member.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
int
|
id of the team |
required |
username
|
str
|
username of the user to remove |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: orgRemoveTeamMember