Codebase list ruby-gitlab / 87adcfe lib / gitlab / client / resource_label_events.rb
87adcfe

Tree @87adcfe (Download .tar.gz)

resource_label_events.rb @87adcfe — raw · history · blame 

 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
# frozen_string_literal: true

class Gitlab::Client
  # Defines methods related to resource label events.
  # @see https://docs.gitlab.com/ee/api/resource_label_events.html
  module ResourceLabelEvents
    # Gets a list of all label events for a single issue.
    #
    # @example
    #   Gitlab.issue_label_events(5, 42)
    #
    # @param  [Integer, String] project The ID or name of a project.
    # @param  [Integer] issue_iid The IID of an issue.
    # @return [Array<Gitlab::ObjectifiedHash>]
    def issue_label_events(project, issue_iid)
      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_label_events")
    end

    # Returns a single label event for a specific project issue
    #
    # @example
    #   Gitlab.issue_label_event(5, 42, 1)
    #
    # @param  [Integer, String] project The ID or name of a project.
    # @param  [Integer] issue_iid The IID of an issue.
    # @param  [Integer] id The ID of a label event.
    # @return Gitlab::ObjectifiedHash
    def issue_label_event(project, issue_iid, id)
      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_label_events/#{id}")
    end

    # Gets a list of all label events for a single epic.
    #
    # @example
    #   Gitlab.epic_label_events(5, 42)
    #
    # @param  [Integer, String] group The ID or name of a group.
    # @param  [Integer] epic_id The ID of an epic.
    # @return [Array<Gitlab::ObjectifiedHash>]
    def epic_label_events(group, epic_id)
      get("/groups/#{url_encode group}/epics/#{epic_id}/resource_label_events")
    end

    # Returns a single label event for a specific group epic
    #
    # @example
    #   Gitlab.epic_label_event(5, 42, 1)
    #
    # @param  [Integer, String] group The ID or name of a group.
    # @param  [Integer] epic_id The ID of an epic.
    # @param  [Integer] id The ID of a label event.
    # @return Gitlab::ObjectifiedHash
    def epic_label_event(group, epic_id, id)
      get("/groups/#{url_encode group}/epics/#{epic_id}/resource_label_events/#{id}")
    end

    # Gets a list of all label events for a single merge request.
    #
    # @example
    #   Gitlab.merge_request_label_events(5, 42)
    #
    # @param  [Integer, String] project The ID or name of a project.
    # @param  [Integer] merge_request_iid The IID of a merge request.
    # @return [Array<Gitlab::ObjectifiedHash>]
    def merge_request_label_events(project, merge_request_iid)
      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_label_events")
    end

    # Returns a single label event for a specific project merge request
    #
    # @example
    #   Gitlab.merge_request_label_event(5, 42, 1)
    #
    # @param  [Integer, String] project The ID or name of a project.
    # @param  [Integer] merge_request_iid The IID of an merge request.
    # @param  [Integer] id The ID of a label event.
    # @return Gitlab::ObjectifiedHash
    def merge_request_label_event(project, merge_request_iid, id)
      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_label_events/#{id}")
    end
  end
end