Team¶
-
class
github.Team.
Team
¶ This class represents Teams. The reference can be found here https://docs.github.com/en/rest/reference/teams
-
id
¶ Type: integer
-
members_count
¶ Type: integer
-
members_url
¶ Type: string
-
name
¶ Type: string
-
description
¶ Type: string
-
permission
¶ Type: string
-
repos_count
¶ Type: integer
-
repositories_url
¶ Type: string
-
slug
¶ Type: string
-
url
¶ Type: string
-
organization
¶ Type: github.Organization.Organization
-
privacy
¶ Type: string
-
parent
¶ Type: string
-
html_url
¶ Type: string
-
add_to_members
(member)¶ This API call is deprecated. Use add_membership instead. https://docs.github.com/en/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy
Calls: PUT /teams/{id}/members/{user} Parameters: member – github.NamedUser.NamedUser
Return type: None
-
add_membership
(member, role=NotSet)¶ Calls: Parameters: - member –
github.Nameduser.NamedUser
- role – string
Return type: None
- member –
-
get_team_membership
(member)¶ Calls: GET /orgs/{org}/memberships/team/{team_id}/{username} Parameters: member – string or github.NamedUser.NamedUser
Return type: github.Membership.Membership
-
add_to_repos
(repo)¶ Calls: PUT /teams/{id}/repos/{org}/{repo} Parameters: repo – github.Repository.Repository
Return type: None
-
get_repo_permission
(repo)¶ Calls: GET /teams/{id}/repos/{org}/{repo} Parameters: repo – string or github.Repository.Repository
Return type: None or github.Permissions.Permissions
-
set_repo_permission
(repo, permission)¶ Calls: Parameters: - repo –
github.Repository.Repository
- permission – string
Return type: None
- repo –
-
update_team_repository
(repo, permission)¶ Calls: Parameters: - repo – string or
github.Repository.Repository
- permission – string
Return type: bool
- repo – string or
-
delete
()¶ Calls: DELETE /teams/{id} Return type: None
-
edit
(name, description=NotSet, permission=NotSet, privacy=NotSet)¶ Calls: Parameters: - name – string
- description – string
- permission – string
- privacy – string
Return type: None
-
get_teams
()¶ Calls: GET /teams/{id}/teams Return type: github.PaginatedList.PaginatedList
ofgithub.Team.Team
-
get_discussions
()¶ Calls: GET /teams/{id}/discussions Return type: github.PaginatedList.PaginatedList
ofgithub.TeamDiscussion.TeamDiscussion
-
get_members
(role=NotSet)¶ Calls: GET /teams/{id}/members Parameters: role – string Return type: github.PaginatedList.PaginatedList
ofgithub.NamedUser.NamedUser
-
get_repos
()¶ Calls: GET /teams/{id}/repos Return type: github.PaginatedList.PaginatedList
ofgithub.Repository.Repository
-
invitations
()¶ Calls: GET /teams/{id}/invitations Return type: github.PaginatedList.PaginatedList
ofgithub.NamedUser.NamedUser
-
has_in_members
(member)¶ Calls: GET /teams/{id}/members/{user} Parameters: member – github.NamedUser.NamedUser
Return type: bool
-
has_in_repos
(repo)¶ Calls: GET /teams/{id}/repos/{owner}/{repo} Parameters: repo – github.Repository.Repository
Return type: bool
-
remove_membership
(member)¶ Calls: DELETE /teams/{team_id}/memberships/{username} Parameters: member – Returns:
-
remove_from_members
(member)¶ This API call is deprecated. Use remove_membership instead: https://docs.github.com/en/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy
Calls: DELETE /teams/{id}/members/{user} Parameters: member – github.NamedUser.NamedUser
Return type: None
-
remove_from_repos
(repo)¶ Calls: DELETE /teams/{id}/repos/{owner}/{repo} Parameters: repo – github.Repository.Repository
Return type: None
-