Codebase list ruby-gitlab / 04d932e lib / gitlab / client / award_emojis.rb
04d932e

Tree @04d932e (Download .tar.gz)

award_emojis.rb @04d932e — 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
 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
class Gitlab::Client
  # Defines methods related to Award Emojis.
  # @see https://docs.gitlab.com/ce/api/award_emoji.html
  module AwardEmojis
    # Gets a list of all award emoji for an awardable(issue, merge request or snippet)
    #
    # @example
    #   Gitlab.award_emojis(1, 80, 'issue')
    #   Gitlab.award_emojis(1, 60, 'merge_request')
    #   Gitlab.award_emojis(1, 40, 'snippet')
    #
    # @param [Integer] project The ID of a project.
    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
    # @return [Array<Gitlab::ObjectifiedHash>]
    def award_emojis(project, awardable_id, awardable_type)
      get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji")
    end

    # Gets a list of all award emoji for a single note on an awardable(issue, merge request or snippet)
    #
    # @example
    #   Gitlab.note_award_emojis(1, 80, 'issue', 1)
    #   Gitlab.note_award_emojis(1, 60, 'merge_request', 1)
    #   Gitlab.note_award_emojis(1, 40, 'snippet', 1)
    #
    # @param [Integer] project The ID of a project.
    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
    # @param [Integer] note_id The ID of a note.
    # @return [Array<Gitlab::ObjectifiedHash>]
    def note_award_emojis(project, awardable_id, awardable_type, note_id)
      get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji")
    end

    # Gets a single award emoji for an awardable(issue, merge request or snippet)
    #
    # @example
    #   Gitlab.award_emoji(1, 80, 'issue', 4)
    #   Gitlab.award_emoji(1, 60, 'merge_request', 4)
    #   Gitlab.award_emoji(1, 40, 'snippet', 4)
    #
    # @param [Integer] project The ID of a project.
    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
    # @param [Integer] award_id The ID of an award emoji.
    # @return [Gitlab::ObjectifiedHash]
    def award_emoji(project, awardable_id, awardable_type, award_id)
      get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji/#{award_id}")
    end

    # Gets a single award emoji from a single note on an awardable(issue, merge request or snippet)
    #
    # @example
    #   Gitlab.note_award_emoji(1, 80, 'issue', 1, 4)
    #   Gitlab.note_award_emoji(1, 60, 'merge_request', 1, 4)
    #   Gitlab.note_award_emoji(1, 40, 'snippet', 1, 4)
    #
    # @param [Integer] project The ID of a project.
    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
    # @param [Integer] note_id The ID of a note.
    # @param [Integer] award_id The ID of an award emoji.
    # @return [Gitlab::ObjectifiedHash]
    def note_award_emoji(project, awardable_id, awardable_type, note_id, award_id)
      get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji/#{award_id}")
    end

    # Awards a new emoji to an awardable(issue, merge request or snippet)
    #
    # @example
    #   Gitlab.create_award_emoji(1, 80, 'issue', 'blowfish')
    #   Gitlab.create_award_emoji(1, 80, 'merge_request', 'blowfish')
    #   Gitlab.create_award_emoji(1, 80, 'snippet', 'blowfish')
    #
    # @param [Integer] project The ID of a project.
    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
    # @param [String] emoji_name The name of the emoji, without colons.
    # @return [Gitlab::ObjectifiedHash]
    def create_award_emoji(project, awardable_id, awardable_type, emoji_name)
      post("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji", body: {name: emoji_name})
    end

    # Awards a new emoji to a note on an awardable(issue, merge request or snippet)
    #
    # @example
    #   Gitlab.create_note_award_emoji(1, 80, 'issue', 1, 'blowfish')
    #   Gitlab.create_note_award_emoji(1, 80, 'merge_request', 1, 'blowfish')
    #   Gitlab.create_note_award_emoji(1, 80, 'snippet', 1, 'blowfish')
    #
    # @param [Integer] project The ID of a project.
    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
    # @param [Integer] note_id The ID of a note.
    # @param [String] emoji_name The name of the emoji, without colons.
    # @return [Gitlab::ObjectifiedHash]
    def create_note_award_emoji(project, awardable_id, awardable_type, note_id, emoji_name)
      post("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji", body: {name: emoji_name})
    end

    # Deletes a single award emoji from an awardable(issue, merge request or snippet)
    #
    # @example
    #   Gitlab.delete_award_emoji(1, 80, 'issue', 4)
    #   Gitlab.delete_award_emoji(1, 60, 'merge_request', 4)
    #   Gitlab.delete_award_emoji(1, 40, 'snippet', 4)
    #
    # @param [Integer] project The ID of a project.
    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
    # @param [Integer] award_id The ID of an award emoji.
    # @return [void] This API call returns an empty response body.
    def delete_award_emoji(project, awardable_id, awardable_type, award_id)
      delete("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji/#{award_id}")
    end

    # Deletes a single award emoji from a single note on an awardable(issue, merge request or snippet)
    #
    # @example
    #   Gitlab.delete_note_award_emoji(1, 80, 'issue', 1, 4)
    #   Gitlab.delete_note_award_emoji(1, 60, 'merge_request', 1, 4)
    #   Gitlab.delete_note_award_emoji(1, 40, 'snippet', 1, 4)
    #
    # @param [Integer] project The ID of a project.
    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
    # @param [Integer] note_id The ID of a note.
    # @param [Integer] award_id The ID of an award emoji.
    # @return [void] This API call returns an empty response body.
    def delete_note_award_emoji(project, awardable_id, awardable_type, note_id, award_id)
      delete("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji/#{award_id}")
    end
  end
end