group.go

// Copyright (c) 2016 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package h1

import (
	"encoding/json"
)

// GroupPermission represent possible permissions sizes for a group
//
// HackerOne API docs: https://api.hackerone.com/docs/v1#group
const (
	GroupPermissionRewardManagement  string = "reward_management"
	GroupPermissionProgramManagement string = "program_management"
	GroupPermissionUserManagement    string = "user_management"
	GroupPermissionReportManagement  string = "report_management"
)

// Group represents a group of users.
//
// HackerOne API docs: https://api.hackerone.com/docs/v1#group
type Group struct {
	ID          *string    `json:"id"`
	Type        *string    `json:"type"`
	Name        *string    `json:"name"`
	Permissions []*string  `json:"permissions"`
	CreatedAt   *Timestamp `json:"created_at"`
}

// Helper types for JSONUnmarshal
type group Group // Used to avoid recursion of JSONUnmarshal
type groupUnmarshalHelper struct {
	group
	Attributes *group `json:"attributes"`
}

// UnmarshalJSON allows JSONAPI attributes and relationships to unmarshal cleanly.
func (g *Group) UnmarshalJSON(b []byte) error {
	var helper groupUnmarshalHelper
	helper.Attributes = &helper.group
	if err := json.Unmarshal(b, &helper); err != nil {
		return err
	}
	*g = Group(helper.group)
	return nil
}