svc_teamusergroup.go

package lokalise

import (
	"fmt"
	"path"
	"strconv"
)

type TeamUserGroupService struct {
	BaseService
}

// ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
// Service entity objects
// _____________________________________________________________________________________________________________________

type TeamUserGroup struct {
	WithCreationTime
	WithTeamID

	GroupID     int64       `json:"group_id"`
	Name        string      `json:"name"`
	Permissions *Permission `json:"permissions"`
	Projects    []string    `json:"projects"`
	Members     []int64     `json:"members"`
}

type Permission struct {
	// IsAdmin is deprecated, and will be removed in next release. Use AdminRights for more granular control.
	IsAdmin bool `json:"is_admin"`
	// IsReviewer is deprecated, and will be removed in next release. Use the appropriate permissions in AdminRights instead.
	IsReviewer bool       `json:"is_reviewer"`
	Languages  []Language `json:"languages,omitempty"`
	// Possible values are activity, branches_main_modify, branches_create, branches_merge, statistics, tasks, contributors, settings, manage_languages, download, upload, glossary_delete, glossary_edit, manage_keys, screenshots, custom_status_modify, review
	AdminRights []string `json:"admin_rights,omitempty"` // todo make admin rights as constants available in the lib
	RoleId      int64    `json:"role_id,omitempty"`
}

// ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
// Service request/response objects
// _____________________________________________________________________________________________________________________
type NewGroupLanguages struct {
	Reference     []int64 `json:"reference"`
	Contributable []int64 `json:"contributable"`
}

type NewGroup struct {
	Name string `json:"name"`
	// IsAdmin is deprecated, and will be removed in next release. Use AdminRights for more granular control.
	IsAdmin bool `json:"is_admin"`
	// IsReviewer is deprecated, and will be removed in next release. Use the appropriate permissions in AdminRights instead.
	IsReviewer bool  `json:"is_reviewer"`
	RoleId     int64 `json:"role_id,omitempty"`

	// Possible values are activity, branches_main_modify, branches_create, branches_merge, statistics, tasks, contributors, settings, manage_languages, download, upload, glossary_delete, glossary_edit, manage_keys, screenshots, custom_status_modify, review
	AdminRights []string          `json:"admin_rights,omitempty"`
	Languages   NewGroupLanguages `json:"languages,omitempty"`
}

type TeamUserGroupsResponse struct {
	Paged
	WithTeamID
	UserGroups []TeamUserGroup `json:"user_groups"`
}

type CreateGroupResponse struct {
	WithTeamID
	Group TeamUserGroup `json:"group"`
}

type DeleteGroupResponse struct {
	WithTeamID
	IsDeleted bool `json:"group_deleted"`
}

// ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
// Service methods
// _____________________________________________________________________________________________________________________

func (c *TeamUserGroupService) List(teamID int64) (r TeamUserGroupsResponse, err error) {
	resp, err := c.getWithOptions(c.Ctx(), pathTeamUserGroups(teamID), &r, c.PageOpts())

	if err != nil {
		return
	}
	applyPaged(resp, &r.Paged)
	return r, apiError(resp)
}

func (c *TeamUserGroupService) Create(teamID int64, group NewGroup) (r CreateGroupResponse, err error) {
	resp, err := c.post(c.Ctx(), pathTeamUserGroups(teamID), &r, group)

	if err != nil {
		return r, err
	}
	return r, apiError(resp)
}

func (c *TeamUserGroupService) Retrieve(teamID, groupID int64) (r TeamUserGroup, err error) {
	url := path.Join(pathTeamUserGroups(teamID), strconv.FormatInt(groupID, 10))
	resp, err := c.get(c.Ctx(), url, &r)

	if err != nil {
		return r, err
	}
	return r, apiError(resp)
}

func (c *TeamUserGroupService) Update(teamID, groupID int64, group NewGroup) (r CreateGroupResponse, err error) {
	url := path.Join(pathTeamUserGroups(teamID), strconv.FormatInt(groupID, 10))
	resp, err := c.put(c.Ctx(), url, &r, group)

	if err != nil {
		return r, err
	}
	return r, apiError(resp)
}

func (c *TeamUserGroupService) AddProjects(teamID, groupID int64, projects []string) (r CreateGroupResponse, err error) {
	url := path.Join(pathTeamUserGroups(teamID), strconv.FormatInt(groupID, 10), "projects", "add")
	resp, err := c.put(c.Ctx(), url, &r, map[string]interface{}{
		"projects": projects,
	})

	if err != nil {
		return r, err
	}
	return r, apiError(resp)
}

func (c *TeamUserGroupService) RemoveProjects(teamID, groupID int64, projects []string) (r CreateGroupResponse, err error) {
	url := path.Join(pathTeamUserGroups(teamID), strconv.FormatInt(groupID, 10), "projects", "remove")
	resp, err := c.put(c.Ctx(), url, &r, map[string]interface{}{
		"projects": projects,
	})

	if err != nil {
		return r, err
	}
	return r, apiError(resp)
}

func (c *TeamUserGroupService) AddMembers(teamID, groupID int64, users []int64) (r CreateGroupResponse, err error) {
	url := path.Join(pathTeamUserGroups(teamID), strconv.FormatInt(groupID, 10), "members", "add")
	resp, err := c.put(c.Ctx(), url, &r, map[string]interface{}{
		"users": users,
	})

	if err != nil {
		return r, err
	}
	return r, apiError(resp)
}

func (c *TeamUserGroupService) RemoveMembers(teamID, groupID int64, users []int64) (r CreateGroupResponse, err error) {
	url := path.Join(pathTeamUserGroups(teamID), strconv.FormatInt(groupID, 10), "members", "remove")
	resp, err := c.put(c.Ctx(), url, &r, map[string]interface{}{
		"users": users,
	})

	if err != nil {
		return r, err
	}
	return r, apiError(resp)
}

func (c *TeamUserGroupService) Delete(teamID, groupID int64) (r DeleteGroupResponse, err error) {
	url := path.Join(pathTeamUserGroups(teamID), strconv.FormatInt(groupID, 10))
	resp, err := c.delete(c.Ctx(), url, &r)

	if err != nil {
		return r, err
	}
	return r, apiError(resp)
}

func pathTeamUserGroups(teamID int64) string {
	return fmt.Sprintf("%s/%d/groups", pathTeams, teamID)
}