taigo/issue_types.go at master · theriverman/taigo · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
package taigo

import (
	"errors"
	"net/http"
	"strconv"
)

// IssueType -> https://docs.taiga.io/api.html#issue-types
type IssueType struct {
	Color     string `json:"color,omitempty"`
	ID        int    `json:"id,omitempty"`
	Name      string `json:"name,omitempty"`
	Order     int    `json:"order,omitempty"`
	ProjectID int    `json:"project_id,omitempty"`
}

// IssueTypeCreateRequest represents payload for creating issue types.
type IssueTypeCreateRequest struct {
	Color   string `json:"color,omitempty"`
	Name    string `json:"name"`
	Order   int    `json:"order,omitempty"`
	Project int    `json:"project"`
}

// IssueTypeEditRequest represents sparse non-destructive updates for issue types.
type IssueTypeEditRequest struct {
	Color   string `json:"color,omitempty"`
	Name    string `json:"name,omitempty"`
	Order   int    `json:"order,omitempty"`
	Project int    `json:"project,omitempty"`
}

// IssueTypePatch represents explicit PATCH payload for issue types.
type IssueTypePatch struct {
	Color   *string `json:"color,omitempty"`
	Name    *string `json:"name,omitempty"`
	Order   *int    `json:"order,omitempty"`
	Project *int    `json:"project,omitempty"`
}

// IssueTypeService is a handle to actions related to issue types.
type IssueTypeService struct {
	client           *Client
	defaultProjectID int
	Endpoint         string
}

// List -> https://docs.taiga.io/api.html#issue-types-list
func (s *IssueTypeService) List(queryParams *ProjectIDQueryParams) ([]IssueType, error) {
	url := s.client.MakeURL(s.Endpoint)
	url, err := urlWithQueryOrDefaultProject(url, queryParams, s.defaultProjectID)
	if err != nil {
		return nil, err
	}
	var issueTypes []IssueType
	_, err = s.client.Request.Get(url, &issueTypes)
	if err != nil {
		return nil, err
	}
	return issueTypes, nil
}

// Get -> https://docs.taiga.io/api.html#issue-types-get
func (s *IssueTypeService) Get(issueTypeID int) (*IssueType, error) {
	if err := requirePositiveID("issueTypeID", issueTypeID); err != nil {
		return nil, err
	}
	url := s.client.MakeURL(s.Endpoint, strconv.Itoa(issueTypeID))
	var issueType IssueType
	_, err := s.client.Request.Get(url, &issueType)
	if err != nil {
		return nil, err
	}
	return &issueType, nil
}

// Create -> https://docs.taiga.io/api.html#issue-types-create
func (s *IssueTypeService) Create(request *IssueTypeCreateRequest) (*IssueType, error) {
	if err := requireNonNil("request", request); err != nil {
		return nil, err
	}
	url := s.client.MakeURL(s.Endpoint)
	var responseIssueType IssueType
	projectID, err := resolveProjectID(request.Project, s.defaultProjectID, "project")
	if err != nil {
		return nil, err
	}
	if isEmpty(request.Name) {
		return nil, errors.New("a mandatory field(project, name) is missing. See API documentation")
	}
	payload := *request
	payload.Project = projectID
	_, err = s.client.Request.Post(url, &payload, &responseIssueType)
	if err != nil {
		return nil, err
	}
	return &responseIssueType, nil
}

// Edit -> https://docs.taiga.io/api.html#issue-types-edit
func (s *IssueTypeService) Edit(issueTypeID int, request *IssueTypeEditRequest) (*IssueType, error) {
	if err := requireNonNil("request", request); err != nil {
		return nil, err
	}
	if err := requirePositiveID("issueTypeID", issueTypeID); err != nil {
		return nil, err
	}
	url := s.client.MakeURL(s.Endpoint, strconv.Itoa(issueTypeID))
	var responseIssueType IssueType
	payload, err := sparsePatchMapFromStruct(request)
	if err != nil {
		return nil, err
	}
	_, err = s.client.Request.Patch(url, &payload, &responseIssueType)
	if err != nil {
		return nil, err
	}
	return &responseIssueType, nil
}

// Update is an alias for Edit.
func (s *IssueTypeService) Update(issueTypeID int, request *IssueTypeEditRequest) (*IssueType, error) {
	return s.Edit(issueTypeID, request)
}

// Patch sends an explicit PATCH payload to edit an issue type.
func (s *IssueTypeService) Patch(issueTypeID int, patch *IssueTypePatch) (*IssueType, error) {
	if err := requireNonNil("patch", patch); err != nil {
		return nil, err
	}
	if err := requirePositiveID("issueTypeID", issueTypeID); err != nil {
		return nil, err
	}
	url := s.client.MakeURL(s.Endpoint, strconv.Itoa(issueTypeID))
	var responseIssueType IssueType
	_, err := s.client.Request.Patch(url, patch, &responseIssueType)
	if err != nil {
		return nil, err
	}
	return &responseIssueType, nil
}

// Delete -> https://docs.taiga.io/api.html#issue-types-delete
func (s *IssueTypeService) Delete(issueTypeID int) (*http.Response, error) {
	if err := requirePositiveID("issueTypeID", issueTypeID); err != nil {
		return nil, err
	}
	url := s.client.MakeURL(s.Endpoint, strconv.Itoa(issueTypeID))
	return s.client.Request.Delete(url)
}