| Module | Gitlab::Client::Groups |
| In: |
lib/gitlab/client/groups.rb
|
Defines methods related to groups. @see github.com/gitlabhq/gitlabhq/blob/master/doc/api/groups.md
Adds a user to group.
@example
Gitlab.add_group_member(1, 2, 40)
@param [Integer] team_id The group id to add a member to. @param [Integer] user_id The user id of the user to add to the team. @param [Integer] access_level Project access level. @return [Gitlab::ObjectifiedHash] Information about added team member.
Creates a new group.
@example
Gitlab.create_group('new-group', 'group-path')
Gitlab.create_group('gitlab', 'gitlab-path', { description: 'New Gitlab project' })
@param [String] name The name of a group. @param [String] path The path of a group. @return [Gitlab::ObjectifiedHash] Information about created group.
Delete‘s a group.
@example
Gitlab.delete_group(42)
@param [Integer] id The ID of a group @return [Gitlab::ObjectifiedHash] Information about the deleted group.
Edit a user of a group.
@example
Gitlab.edit_group_member(1, 2, 40)
@param [Integer] team_id The group id of member to edit. @param [Integer] user_id The user id of the user to edit. @param [Integer] access_level Project access level. @return [Gitlab::ObjectifiedHash] Information about edited team member.
Gets a single group.
@example
Gitlab.group(42)
@param [Integer] id The ID of a group. @return [Gitlab::ObjectifiedHash]
Get a list of group members.
@example
Gitlab.group_members(1)
Gitlab.group_members(1, { per_page: 40 })
@param [Integer] id The ID of a group. @param [Hash] options A customizable set of options. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]
Get a list of projects under a group @example
Gitlab.group_projects(1)
@param [Integer] id The ID of a group @return [Array<Gitlab::ObjectifiedHash>] List of projects under a group
Search for groups by name
@example
Gitlab.group_search('gitlab')
@param [String] search A string to search for in group names and paths. @param [Hash] options A customizable set of options. @option options [String] :per_page Number of projects to return per page @option options [String] :page The page to retrieve @return [Array<Gitlab::ObjectifiedHash>]
Gets a list of groups.
@example
Gitlab.groups
Gitlab.groups({ per_page: 40, page: 2 })
@param [Hash] options A customizable set of options. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]
Removes user from user group.
@example
Gitlab.remove_group_member(1, 2)
@param [Integer] team_id The group ID. @param [Integer] user_id The ID of a user. @return [Gitlab::ObjectifiedHash] Information about removed team member.