Codebase list ruby-gitlab / 3902111 lib / gitlab / client / resource_state_events.rb
3902111

Tree @3902111 (Download .tar.gz)

resource_state_events.rb @3902111 — 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
# frozen_string_literal: true

class Gitlab::Client
  # Defines methods related to resource state events.
  # @see https://docs.gitlab.com/ee/api/resource_state_events.html
  module ResourceStateEvents
    # Gets a list of all state events for a single issue.
    #
    # @example
    #   Gitlab.issue_state_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_state_events(project, issue_iid)
      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_state_events")
    end

    # Returns a single state event for a specific project issue
    #
    # @example
    #   Gitlab.issue_state_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 resource event.
    # @return Gitlab::ObjectifiedHash
    def issue_state_event(project, issue_iid, id)
      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_state_events/#{id}")
    end

    # Gets a list of all state events for a single merge request.
    #
    # @example
    #   Gitlab.merge_request_state_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_state_events(project, merge_request_iid)
      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_state_events")
    end

    # Returns a single state event for a specific project merge request
    #
    # @example
    #   Gitlab.merge_request_state_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 state event.
    # @return Gitlab::ObjectifiedHash
    def merge_request_state_event(project, merge_request_iid, id)
      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_state_events/#{id}")
    end
  end
end