resource_label_events.go

  1//
  2// Copyright 2017, Sander van Harmelen
  3//
  4// Licensed under the Apache License, Version 2.0 (the "License");
  5// you may not use this file except in compliance with the License.
  6// You may obtain a copy of the License at
  7//
  8//     http://www.apache.org/licenses/LICENSE-2.0
  9//
 10// Unless required by applicable law or agreed to in writing, software
 11// distributed under the License is distributed on an "AS IS" BASIS,
 12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 13// See the License for the specific language governing permissions and
 14// limitations under the License.
 15//
 16
 17package gitlab
 18
 19import (
 20	"fmt"
 21	"time"
 22)
 23
 24// ResourceLabelEventsService handles communication with the event related
 25// methods of the GitLab API.
 26//
 27// GitLab API docs: https://docs.gitlab.com/ee/api/resource_label_events.html
 28type ResourceLabelEventsService struct {
 29	client *Client
 30}
 31
 32// LabelEvent represents a resource label event.
 33//
 34// GitLab API docs:
 35// https://docs.gitlab.com/ee/api/resource_label_events.html#get-single-issue-label-event
 36type LabelEvent struct {
 37	ID           int        `json:"id"`
 38	Action       string     `json:"action"`
 39	CreatedAt    *time.Time `json:"created_at"`
 40	ResourceType string     `json:"resource_type"`
 41	ResourceID   int        `json:"resource_id"`
 42	User         struct {
 43		ID        int    `json:"id"`
 44		Name      string `json:"name"`
 45		Username  string `json:"username"`
 46		State     string `json:"state"`
 47		AvatarURL string `json:"avatar_url"`
 48		WebURL    string `json:"web_url"`
 49	} `json:"user"`
 50	Label struct {
 51		ID          int    `json:"id"`
 52		Name        string `json:"name"`
 53		Color       string `json:"color"`
 54		TextColor   string `json:"text_color"`
 55		Description string `json:"description"`
 56	} `json:"label"`
 57}
 58
 59// ListLabelEventsOptions represents the options for all resource label events
 60// list methods.
 61//
 62// GitLab API docs:
 63// https://docs.gitlab.com/ee/api/resource_label_events.html#list-project-issue-label-events
 64type ListLabelEventsOptions struct {
 65	ListOptions
 66}
 67
 68// ListIssueLabelEvents retrieves resource label events for the
 69// specified project and issue.
 70//
 71// GitLab API docs:
 72// https://docs.gitlab.com/ee/api/resource_label_events.html#list-project-issue-label-events
 73func (s *ResourceLabelEventsService) ListIssueLabelEvents(pid interface{}, issue int, opt *ListLabelEventsOptions, options ...OptionFunc) ([]*LabelEvent, *Response, error) {
 74	project, err := parseID(pid)
 75	if err != nil {
 76		return nil, nil, err
 77	}
 78	u := fmt.Sprintf("projects/%s/issues/%d/resource_label_events", pathEscape(project), issue)
 79
 80	req, err := s.client.NewRequest("GET", u, opt, options)
 81	if err != nil {
 82		return nil, nil, err
 83	}
 84
 85	var ls []*LabelEvent
 86	resp, err := s.client.Do(req, &ls)
 87	if err != nil {
 88		return nil, resp, err
 89	}
 90
 91	return ls, resp, err
 92}
 93
 94// GetIssueLabelEvent gets a single issue-label-event.
 95//
 96// GitLab API docs:
 97// https://docs.gitlab.com/ee/api/resource_label_events.html#get-single-issue-label-event
 98func (s *ResourceLabelEventsService) GetIssueLabelEvent(pid interface{}, issue int, event int, options ...OptionFunc) (*LabelEvent, *Response, error) {
 99	project, err := parseID(pid)
100	if err != nil {
101		return nil, nil, err
102	}
103	u := fmt.Sprintf("projects/%s/issues/%d/resource_label_events/%d", pathEscape(project), issue, event)
104
105	req, err := s.client.NewRequest("GET", u, nil, options)
106	if err != nil {
107		return nil, nil, err
108	}
109
110	l := new(LabelEvent)
111	resp, err := s.client.Do(req, l)
112	if err != nil {
113		return nil, resp, err
114	}
115
116	return l, resp, err
117}
118
119// ListGroupEpicLabelEvents retrieves resource label events for the specified
120// group and epic.
121//
122// GitLab API docs:
123// https://docs.gitlab.com/ee/api/resource_label_events.html#list-group-epic-label-events
124func (s *ResourceLabelEventsService) ListGroupEpicLabelEvents(gid interface{}, epic int, opt *ListLabelEventsOptions, options ...OptionFunc) ([]*LabelEvent, *Response, error) {
125	group, err := parseID(gid)
126	if err != nil {
127		return nil, nil, err
128	}
129	u := fmt.Sprintf("groups/%s/epics/%d/resource_label_events", pathEscape(group), epic)
130
131	req, err := s.client.NewRequest("GET", u, opt, options)
132	if err != nil {
133		return nil, nil, err
134	}
135
136	var ls []*LabelEvent
137	resp, err := s.client.Do(req, &ls)
138	if err != nil {
139		return nil, resp, err
140	}
141
142	return ls, resp, err
143}
144
145// GetGroupEpicLabelEvent gets a single group epic label event.
146//
147// GitLab API docs:
148// https://docs.gitlab.com/ee/api/resource_label_events.html#get-single-epic-label-event
149func (s *ResourceLabelEventsService) GetGroupEpicLabelEvent(gid interface{}, epic int, event int, options ...OptionFunc) (*LabelEvent, *Response, error) {
150	group, err := parseID(gid)
151	if err != nil {
152		return nil, nil, err
153	}
154	u := fmt.Sprintf("groups/%s/epics/%d/resource_label_events/%d", pathEscape(group), epic, event)
155
156	req, err := s.client.NewRequest("GET", u, nil, options)
157	if err != nil {
158		return nil, nil, err
159	}
160
161	l := new(LabelEvent)
162	resp, err := s.client.Do(req, l)
163	if err != nil {
164		return nil, resp, err
165	}
166
167	return l, resp, err
168}
169
170// ListMergeLabelEvents retrieves resource label events for the specified
171// project and merge request.
172//
173// GitLab API docs:
174// https://docs.gitlab.com/ee/api/resource_label_events.html#list-project-merge-request-label-events
175func (s *ResourceLabelEventsService) ListMergeLabelEvents(pid interface{}, request int, opt *ListLabelEventsOptions, options ...OptionFunc) ([]*LabelEvent, *Response, error) {
176	project, err := parseID(pid)
177	if err != nil {
178		return nil, nil, err
179	}
180	u := fmt.Sprintf("projects/%s/merge_requests/%d/resource_label_events", pathEscape(project), request)
181
182	req, err := s.client.NewRequest("GET", u, opt, options)
183	if err != nil {
184		return nil, nil, err
185	}
186
187	var ls []*LabelEvent
188	resp, err := s.client.Do(req, &ls)
189	if err != nil {
190		return nil, resp, err
191	}
192
193	return ls, resp, err
194}
195
196// GetMergeRequestLabelEvent gets a single merge request label event.
197//
198// GitLab API docs:
199// https://docs.gitlab.com/ee/api/resource_label_events.html#get-single-merge-request-label-event
200func (s *ResourceLabelEventsService) GetMergeRequestLabelEvent(pid interface{}, request int, event int, options ...OptionFunc) (*LabelEvent, *Response, error) {
201	project, err := parseID(pid)
202	if err != nil {
203		return nil, nil, err
204	}
205	u := fmt.Sprintf("projects/%s/merge_requests/%d/resource_label_events/%d", pathEscape(project), request, event)
206
207	req, err := s.client.NewRequest("GET", u, nil, options)
208	if err != nil {
209		return nil, nil, err
210	}
211
212	l := new(LabelEvent)
213	resp, err := s.client.Do(req, l)
214	if err != nil {
215		return nil, resp, err
216	}
217
218	return l, resp, err
219}