// // Copyright 2017, Sander van Harmelen // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // package gitlab import ( "fmt" "net/url" ) // GroupMembersService handles communication with the group members // related methods of the GitLab API. // // GitLab API docs: https://docs.gitlab.com/ce/api/members.html type GroupMembersService struct { client *Client } // GroupMember represents a GitLab group member. // // GitLab API docs: https://docs.gitlab.com/ce/api/members.html type GroupMember struct { ID int `json:"id"` Username string `json:"username"` Name string `json:"name"` State string `json:"state"` AvatarURL string `json:"avatar_url"` WebURL string `json:"web_url"` ExpiresAt *ISOTime `json:"expires_at"` AccessLevel AccessLevelValue `json:"access_level"` } // ListGroupMembersOptions represents the available ListGroupMembers() and // ListAllGroupMembers() options. // // GitLab API docs: // https://docs.gitlab.com/ce/api/members.html#list-all-members-of-a-group-or-project type ListGroupMembersOptions struct { ListOptions Query *string `url:"query,omitempty" json:"query,omitempty"` } // ListGroupMembers get a list of group members viewable by the authenticated // user. Returns a list including inherited members through ancestor groups. // // GitLab API docs: // https://docs.gitlab.com/ce/api/members.html#list-all-members-of-a-group-or-project func (s *GroupsService) ListGroupMembers(gid interface{}, opt *ListGroupMembersOptions, options ...OptionFunc) ([]*GroupMember, *Response, error) { group, err := parseID(gid) if err != nil { return nil, nil, err } u := fmt.Sprintf("groups/%s/members", url.QueryEscape(group)) req, err := s.client.NewRequest("GET", u, opt, options) if err != nil { return nil, nil, err } var gm []*GroupMember resp, err := s.client.Do(req, &gm) if err != nil { return nil, resp, err } return gm, resp, err } // ListAllGroupMembers get a list of group members viewable by the authenticated // user. Returns a list including inherited members through ancestor groups. // // GitLab API docs: // https://docs.gitlab.com/ce/api/members.html#list-all-members-of-a-group-or-project-including-inherited-members func (s *GroupsService) ListAllGroupMembers(gid interface{}, opt *ListGroupMembersOptions, options ...OptionFunc) ([]*GroupMember, *Response, error) { group, err := parseID(gid) if err != nil { return nil, nil, err } u := fmt.Sprintf("groups/%s/members/all", url.QueryEscape(group)) req, err := s.client.NewRequest("GET", u, opt, options) if err != nil { return nil, nil, err } var gm []*GroupMember resp, err := s.client.Do(req, &gm) if err != nil { return nil, resp, err } return gm, resp, err } // AddGroupMemberOptions represents the available AddGroupMember() options. // // GitLab API docs: // https://docs.gitlab.com/ce/api/members.html#add-a-member-to-a-group-or-project type AddGroupMemberOptions struct { UserID *int `url:"user_id,omitempty" json:"user_id,omitempty"` AccessLevel *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"` ExpiresAt *string `url:"expires_at,omitempty" json:"expires_at"` } // GetGroupMember gets a member of a group. // // GitLab API docs: // https://docs.gitlab.com/ce/api/members.html#get-a-member-of-a-group-or-project func (s *GroupMembersService) GetGroupMember(gid interface{}, user int, options ...OptionFunc) (*GroupMember, *Response, error) { group, err := parseID(gid) if err != nil { return nil, nil, err } u := fmt.Sprintf("groups/%s/members/%d", url.QueryEscape(group), user) req, err := s.client.NewRequest("GET", u, nil, options) if err != nil { return nil, nil, err } gm := new(GroupMember) resp, err := s.client.Do(req, gm) if err != nil { return nil, resp, err } return gm, resp, err } // AddGroupMember adds a user to the list of group members. // // GitLab API docs: // https://docs.gitlab.com/ce/api/members.html#add-a-member-to-a-group-or-project func (s *GroupMembersService) AddGroupMember(gid interface{}, opt *AddGroupMemberOptions, options ...OptionFunc) (*GroupMember, *Response, error) { group, err := parseID(gid) if err != nil { return nil, nil, err } u := fmt.Sprintf("groups/%s/members", url.QueryEscape(group)) req, err := s.client.NewRequest("POST", u, opt, options) if err != nil { return nil, nil, err } gm := new(GroupMember) resp, err := s.client.Do(req, gm) if err != nil { return nil, resp, err } return gm, resp, err } // EditGroupMemberOptions represents the available EditGroupMember() // options. // // GitLab API docs: // https://docs.gitlab.com/ce/api/members.html#edit-a-member-of-a-group-or-project type EditGroupMemberOptions struct { AccessLevel *AccessLevelValue `url:"access_level,omitempty" json:"access_level,omitempty"` ExpiresAt *string `url:"expires_at,omitempty" json:"expires_at"` } // EditGroupMember updates a member of a group. // // GitLab API docs: // https://docs.gitlab.com/ce/api/members.html#edit-a-member-of-a-group-or-project func (s *GroupMembersService) EditGroupMember(gid interface{}, user int, opt *EditGroupMemberOptions, options ...OptionFunc) (*GroupMember, *Response, error) { group, err := parseID(gid) if err != nil { return nil, nil, err } u := fmt.Sprintf("groups/%s/members/%d", url.QueryEscape(group), user) req, err := s.client.NewRequest("PUT", u, opt, options) if err != nil { return nil, nil, err } gm := new(GroupMember) resp, err := s.client.Do(req, gm) if err != nil { return nil, resp, err } return gm, resp, err } // RemoveGroupMember removes user from user team. // // GitLab API docs: // https://docs.gitlab.com/ce/api/members.html#remove-a-member-from-a-group-or-project func (s *GroupMembersService) RemoveGroupMember(gid interface{}, user int, options ...OptionFunc) (*Response, error) { group, err := parseID(gid) if err != nil { return nil, err } u := fmt.Sprintf("groups/%s/members/%d", url.QueryEscape(group), user) req, err := s.client.NewRequest("DELETE", u, nil, options) if err != nil { return nil, err } return s.client.Do(req, nil) }