View Source GitHub.Teams (GitHub REST API Client v0.0.9)
Provides API endpoints related to teams
Link to this section Summary
Functions
Add team member (Legacy)
Add or update team membership for a user
Add or update team membership for a user (Legacy)
Add or update team project permissions
Add or update team project permissions (Legacy)
Add or update team repository permissions
Add or update team repository permissions (Legacy)
Check team permissions for a project
Check team permissions for a project (Legacy)
Check team permissions for a repository
Check team permissions for a repository (Legacy)
Create a team
Create a discussion comment
Create a discussion comment (Legacy)
Create a discussion
Create a discussion (Legacy)
Delete a discussion comment
Delete a discussion comment (Legacy)
Delete a discussion
Delete a discussion (Legacy)
Delete a team
Delete a team (Legacy)
Get a team by name
Get a discussion comment
Get a discussion comment (Legacy)
Get a discussion
Get a discussion (Legacy)
Get a team (Legacy)
Get team member (Legacy)
Get team membership for a user
Get team membership for a user (Legacy)
List teams
List child teams
List child teams (Legacy)
List discussion comments
List discussion comments (Legacy)
List discussions
List discussions (Legacy)
List teams for the authenticated user
List team members
List team members (Legacy)
List pending team invitations
List pending team invitations (Legacy)
List team projects
List team projects (Legacy)
List team repositories
List team repositories (Legacy)
Remove team member (Legacy)
Remove team membership for a user
Remove team membership for a user (Legacy)
Remove a project from a team
Remove a project from a team (Legacy)
Remove a repository from a team
Remove a repository from a team (Legacy)
Update a discussion comment
Update a discussion comment (Legacy)
Update a discussion
Update a discussion (Legacy)
Update a team
Update a team (Legacy)
Link to this section Functions
@spec add_member_legacy(integer(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Add team member (Legacy)
resources
Resources
add_or_update_membership_for_user_in_org(org, team_slug, username, body, opts \\ [])
View Source@spec add_or_update_membership_for_user_in_org( String.t(), String.t(), String.t(), map(), keyword() ) :: {:ok, GitHub.Team.Membership.t()} | {:error, GitHub.Error.t()}
Add or update team membership for a user
resources
Resources
add_or_update_membership_for_user_legacy(team_id, username, body, opts \\ [])
View Source@spec add_or_update_membership_for_user_legacy( integer(), String.t(), map(), keyword() ) :: {:ok, GitHub.Team.Membership.t()} | {:error, GitHub.Error.t()}
Add or update team membership for a user (Legacy)
resources
Resources
add_or_update_project_permissions_in_org(org, team_slug, project_id, body, opts \\ [])
View Source@spec add_or_update_project_permissions_in_org( String.t(), String.t(), integer(), map() | nil, keyword() ) :: :ok | {:error, GitHub.Error.t()}
Add or update team project permissions
resources
Resources
add_or_update_project_permissions_legacy(team_id, project_id, body, opts \\ [])
View Source@spec add_or_update_project_permissions_legacy(integer(), integer(), map(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Add or update team project permissions (Legacy)
resources
Resources
add_or_update_repo_permissions_in_org(org, team_slug, owner, repo, body, opts \\ [])
View Source@spec add_or_update_repo_permissions_in_org( String.t(), String.t(), String.t(), String.t(), map(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Add or update team repository permissions
resources
Resources
add_or_update_repo_permissions_legacy(team_id, owner, repo, body, opts \\ [])
View Source@spec add_or_update_repo_permissions_legacy( integer(), String.t(), String.t(), map(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Add or update team repository permissions (Legacy)
resources
Resources
check_permissions_for_project_in_org(org, team_slug, project_id, opts \\ [])
View Source@spec check_permissions_for_project_in_org( String.t(), String.t(), integer(), keyword() ) :: {:ok, GitHub.Team.Project.t()} | {:error, GitHub.Error.t()}
Check team permissions for a project
resources
Resources
check_permissions_for_project_legacy(team_id, project_id, opts \\ [])
View Source@spec check_permissions_for_project_legacy(integer(), integer(), keyword()) :: {:ok, GitHub.Team.Project.t()} | {:error, GitHub.Error.t()}
Check team permissions for a project (Legacy)
resources
Resources
check_permissions_for_repo_in_org(org, team_slug, owner, repo, opts \\ [])
View Source@spec check_permissions_for_repo_in_org( String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GitHub.Team.Repository.t()} | {:error, GitHub.Error.t()}
Check team permissions for a repository
resources
Resources
check_permissions_for_repo_legacy(team_id, owner, repo, opts \\ [])
View Source@spec check_permissions_for_repo_legacy(integer(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Team.Repository.t()} | {:error, GitHub.Error.t()}
Check team permissions for a repository (Legacy)
resources
Resources
@spec create(String.t(), map(), keyword()) :: {:ok, GitHub.Team.full()} | {:error, GitHub.Error.t()}
Create a team
resources
Resources
create_discussion_comment_in_org(org, team_slug, discussion_number, body, opts \\ [])
View Source@spec create_discussion_comment_in_org( String.t(), String.t(), integer(), map(), keyword() ) :: {:ok, GitHub.Team.DiscussionComment.t()} | {:error, GitHub.Error.t()}
Create a discussion comment
resources
Resources
create_discussion_comment_legacy(team_id, discussion_number, body, opts \\ [])
View Source@spec create_discussion_comment_legacy(integer(), integer(), map(), keyword()) :: {:ok, GitHub.Team.DiscussionComment.t()} | {:error, GitHub.Error.t()}
Create a discussion comment (Legacy)
resources
Resources
@spec create_discussion_in_org(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Team.Discussion.t()} | {:error, GitHub.Error.t()}
Create a discussion
resources
Resources
@spec create_discussion_legacy(integer(), map(), keyword()) :: {:ok, GitHub.Team.Discussion.t()} | {:error, GitHub.Error.t()}
Create a discussion (Legacy)
resources
Resources
delete_discussion_comment_in_org(org, team_slug, discussion_number, comment_number, opts \\ [])
View Source@spec delete_discussion_comment_in_org( String.t(), String.t(), integer(), integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete a discussion comment
resources
Resources
delete_discussion_comment_legacy(team_id, discussion_number, comment_number, opts \\ [])
View Source@spec delete_discussion_comment_legacy(integer(), integer(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a discussion comment (Legacy)
resources
Resources
delete_discussion_in_org(org, team_slug, discussion_number, opts \\ [])
View Source@spec delete_discussion_in_org(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a discussion
resources
Resources
@spec delete_discussion_legacy(integer(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a discussion (Legacy)
resources
Resources
@spec delete_in_org(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a team
resources
Resources
@spec delete_legacy( integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete a team (Legacy)
resources
Resources
@spec get_by_name(String.t(), String.t(), keyword()) :: {:ok, GitHub.Team.full()} | {:error, GitHub.Error.t()}
Get a team by name
resources
Resources
get_discussion_comment_in_org(org, team_slug, discussion_number, comment_number, opts \\ [])
View Source@spec get_discussion_comment_in_org( String.t(), String.t(), integer(), integer(), keyword() ) :: {:ok, GitHub.Team.DiscussionComment.t()} | {:error, GitHub.Error.t()}
Get a discussion comment
resources
Resources
get_discussion_comment_legacy(team_id, discussion_number, comment_number, opts \\ [])
View Source@spec get_discussion_comment_legacy(integer(), integer(), integer(), keyword()) :: {:ok, GitHub.Team.DiscussionComment.t()} | {:error, GitHub.Error.t()}
Get a discussion comment (Legacy)
resources
Resources
get_discussion_in_org(org, team_slug, discussion_number, opts \\ [])
View Source@spec get_discussion_in_org(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Team.Discussion.t()} | {:error, GitHub.Error.t()}
Get a discussion
resources
Resources
@spec get_discussion_legacy(integer(), integer(), keyword()) :: {:ok, GitHub.Team.Discussion.t()} | {:error, GitHub.Error.t()}
Get a discussion (Legacy)
resources
Resources
@spec get_legacy( integer(), keyword() ) :: {:ok, GitHub.Team.full()} | {:error, GitHub.Error.t()}
Get a team (Legacy)
resources
Resources
@spec get_member_legacy(integer(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Get team member (Legacy)
resources
Resources
get_membership_for_user_in_org(org, team_slug, username, opts \\ [])
View Source@spec get_membership_for_user_in_org(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Team.Membership.t()} | {:error, GitHub.Error.t()}
Get team membership for a user
resources
Resources
@spec get_membership_for_user_legacy(integer(), String.t(), keyword()) :: {:ok, GitHub.Team.Membership.t()} | {:error, GitHub.Error.t()}
Get team membership for a user (Legacy)
resources
Resources
@spec list( String.t(), keyword() ) :: {:ok, [GitHub.Team.t()]} | {:error, GitHub.Error.t()}
List teams
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_child_in_org(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Team.t()]} | {:error, GitHub.Error.t()}
List child teams
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_child_legacy( integer(), keyword() ) :: {:ok, [GitHub.Team.t()]} | {:error, GitHub.Error.t()}
List child teams (Legacy)
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
list_discussion_comments_in_org(org, team_slug, discussion_number, opts \\ [])
View Source@spec list_discussion_comments_in_org(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Team.DiscussionComment.t()]} | {:error, GitHub.Error.t()}
List discussion comments
options
Options
direction
(String.t()): The direction to sort the results by.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
list_discussion_comments_legacy(team_id, discussion_number, opts \\ [])
View Source@spec list_discussion_comments_legacy(integer(), integer(), keyword()) :: {:ok, [GitHub.Team.DiscussionComment.t()]} | {:error, GitHub.Error.t()}
List discussion comments (Legacy)
options
Options
direction
(String.t()): The direction to sort the results by.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_discussions_in_org(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Team.Discussion.t()]} | {:error, GitHub.Error.t()}
List discussions
options
Options
direction
(String.t()): The direction to sort the results by.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.pinned
(String.t()): Pinned discussions only filter
resources
Resources
@spec list_discussions_legacy( integer(), keyword() ) :: {:ok, [GitHub.Team.Discussion.t()]} | {:error, GitHub.Error.t()}
List discussions (Legacy)
options
Options
direction
(String.t()): The direction to sort the results by.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_for_authenticated_user(keyword()) :: {:ok, [GitHub.Team.full()]} | {:error, GitHub.Error.t()}
List teams for the authenticated user
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_members_in_org(String.t(), String.t(), keyword()) :: {:ok, [GitHub.User.simple()]} | {:error, GitHub.Error.t()}
List team members
options
Options
role
(String.t()): Filters members returned by their role in the team.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_members_legacy( integer(), keyword() ) :: {:ok, [GitHub.User.simple()]} | {:error, GitHub.Error.t()}
List team members (Legacy)
options
Options
role
(String.t()): Filters members returned by their role in the team.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_pending_invitations_in_org(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Organization.Invitation.t()]} | {:error, GitHub.Error.t()}
List pending team invitations
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_pending_invitations_legacy( integer(), keyword() ) :: {:ok, [GitHub.Organization.Invitation.t()]} | {:error, GitHub.Error.t()}
List pending team invitations (Legacy)
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_projects_in_org(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Team.Project.t()]} | {:error, GitHub.Error.t()}
List team projects
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_projects_legacy( integer(), keyword() ) :: {:ok, [GitHub.Team.Project.t()]} | {:error, GitHub.Error.t()}
List team projects (Legacy)
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_repos_in_org(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Repository.minimal()]} | {:error, GitHub.Error.t()}
List team repositories
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_repos_legacy( integer(), keyword() ) :: {:ok, [GitHub.Repository.minimal()]} | {:error, GitHub.Error.t()}
List team repositories (Legacy)
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec remove_member_legacy(integer(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Remove team member (Legacy)
resources
Resources
remove_membership_for_user_in_org(org, team_slug, username, opts \\ [])
View Source@spec remove_membership_for_user_in_org(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Remove team membership for a user
resources
Resources
@spec remove_membership_for_user_legacy(integer(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Remove team membership for a user (Legacy)
resources
Resources
@spec remove_project_in_org(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Remove a project from a team
resources
Resources
@spec remove_project_legacy(integer(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Remove a project from a team (Legacy)
resources
Resources
@spec remove_repo_in_org(String.t(), String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Remove a repository from a team
resources
Resources
@spec remove_repo_legacy(integer(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Remove a repository from a team (Legacy)
resources
Resources
update_discussion_comment_in_org(org, team_slug, discussion_number, comment_number, body, opts \\ [])
View Source@spec update_discussion_comment_in_org( String.t(), String.t(), integer(), integer(), map(), keyword() ) :: {:ok, GitHub.Team.DiscussionComment.t()} | {:error, GitHub.Error.t()}
Update a discussion comment
resources
Resources
update_discussion_comment_legacy(team_id, discussion_number, comment_number, body, opts \\ [])
View Source@spec update_discussion_comment_legacy( integer(), integer(), integer(), map(), keyword() ) :: {:ok, GitHub.Team.DiscussionComment.t()} | {:error, GitHub.Error.t()}
Update a discussion comment (Legacy)
resources
Resources
update_discussion_in_org(org, team_slug, discussion_number, body, opts \\ [])
View Source@spec update_discussion_in_org(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Team.Discussion.t()} | {:error, GitHub.Error.t()}
Update a discussion
resources
Resources
update_discussion_legacy(team_id, discussion_number, body, opts \\ [])
View Source@spec update_discussion_legacy(integer(), integer(), map(), keyword()) :: {:ok, GitHub.Team.Discussion.t()} | {:error, GitHub.Error.t()}
Update a discussion (Legacy)
resources
Resources
@spec update_in_org(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Team.full()} | {:error, GitHub.Error.t()}
Update a team
resources
Resources
@spec update_legacy(integer(), map(), keyword()) :: {:ok, GitHub.Team.full()} | {:error, GitHub.Error.t()}
Update a team (Legacy)