module Gitlab::Client::GroupBadges

def add_group_badge(group, options = {})

Returns:
  • (Gitlab::ObjectifiedHash) - Information about the added group badge.

Options Hash: (**options)
  • :image_url(required) (String) -- URL of the badge image
  • :link_url(required) (String) -- URL of the badge link

Parameters:
  • options (Hash) -- A customizable set of options.
  • group(required) (Integer, String) -- The ID or URL-encoded path of the group owned by the authenticated user. 
def add_group_badge(group, options = {})
  post("/groups/#{url_encode group}/badges", body: options)
end

def edit_group_badge(group, badge_id, options = {})

Returns:
  • (Gitlab::ObjectifiedHash) - Information about the updated group badge.

Options Hash: (**options)
  • :image_url(optional) (String) -- URL of the badge image
  • :link_url(optional) (String) -- URL of the badge link

Parameters:
  • options (Hash) -- A customizable set of options.
  • badge_id(required) (Integer) -- The badge ID.
  • group(required) (Integer, String) -- The ID or URL-encoded path of the group owned by the authenticated user. 
def edit_group_badge(group, badge_id, options = {})
  put("/groups/#{url_encode group}/badges/#{badge_id}", body: options)
end

def group_badge(group, badge_id)

Returns:
  • (Gitlab::ObjectifiedHash) - Information about the requested badge

Parameters:
  • badge_id(required) (Integer) -- The badge ID.
  • group(required) (Integer, String) -- The ID or URL-encoded path of the group owned by the authenticated user. 
def group_badge(group, badge_id)
  get("/groups/#{url_encode group}/badges/#{badge_id}")
end

def group_badges(group, name = nil)

Returns:
  • (Array) - List of all badges of a group

Parameters:
  • name(optional) (String) -- Name of the badges to return (case-sensitive).
  • group(required) (Integer, String) -- The ID or URL-encoded path of the group owned by the authenticated user. 
def group_badges(group, name = nil)
  query = { name: name } if name
  get("/groups/#{url_encode group}/badges", query: query)
end

def preview_group_badge(group, link_url, image_url)

Returns:
  • (Gitlab::ObjectifiedHash) - Returns how the link_url and image_url final URLs would be after resolving the placeholder interpolation.

Parameters:
  • :image_url(required) (String) -- URL of the badge image
  • :link_url(required) (String) -- URL of the badge link
  • group(required) (Integer, String) -- The ID or URL-encoded path of the group owned by the authenticated user. 
def preview_group_badge(group, link_url, image_url)
  query = { link_url: link_url, image_url: image_url }
  get("/groups/#{url_encode group}/badges/render", query: query)
end

def remove_group_badge(group, badge_id)

Returns:
  • (nil) - This API call returns an empty response body.

Parameters:
  • badge_id(required) (Integer) -- The badge ID.
  • group(required) (Integer, String) -- The ID or URL-encoded path of the group owned by the authenticated user. 
def remove_group_badge(group, badge_id)
  delete("/groups/#{url_encode group}/badges/#{badge_id}")
end