gitlab 4.2.0 → 4.18.0

data/lib/gitlab/client/access_requests.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to Award Emojis.
+  # @see https://docs.gitlab.com/ce/api/access_requests.html
+  module AccessRequests
+    # Gets a list of access requests for a project viewable by the authenticated user.
+    #
+    # @example
+    #   Gitlab.project_access_requests(1)
+    #
+    # @param  [Integer, String] :project(required) The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of project access requests
+    def project_access_requests(project)
+      get("/projects/#{url_encode project}/access_requests")
+    end
+
+    # Gets a list of access requests for a group viewable by the authenticated user.
+    #
+    # @example
+    #   Gitlab.group_access_requests(1)
+    #
+    # @param  [Integer, String] :group(required) The ID or name of a group.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of group access requests
+    def group_access_requests(group)
+      get("/groups/#{url_encode group}/access_requests")
+    end
+
+    # Requests access for the authenticated user to a project.
+    #
+    # @example
+    #    Gitlab.request_project_access(1)
+    #
+    # @param  [Integer, String] :project(required) The ID or name of a project.
+    # @return <Gitlab::ObjectifiedHash] Information about the requested project access
+    def request_project_access(project)
+      post("/projects/#{url_encode project}/access_requests")
+    end
+
+    # Requests access for the authenticated user to a group.
+    #
+    # @example
+    #    Gitlab.request_group_access(1)
+    #
+    # @param  [Integer, String] :group(required) The ID or name of a group.
+    # @return <Gitlab::ObjectifiedHash] Information about the requested group access
+    def request_group_access(group)
+      post("/groups/#{url_encode group}/access_requests")
+    end
+
+    # Approves a project access request for the given user.
+    #
+    # @example
+    #    Gitlab.approve_project_access_request(1, 1)
+    #    Gitlab.approve_project_access_request(1, 1, {access_level: '30'})
+    #
+    # @param  [Integer, String] :project(required) The ID or name of a project.
+    # @param  [Integer] :user_id(required) The user ID of the access requester
+    # @option options [Integer] :access_level(optional) A valid access level (defaults: 30, developer access level)
+    # @return <Gitlab::ObjectifiedHash] Information about the approved project access request
+    def approve_project_access_request(project, user_id, options = {})
+      put("/projects/#{url_encode project}/access_requests/#{user_id}/approve", body: options)
+    end
+
+    # Approves a group access request for the given user.
+    #
+    # @example
+    #    Gitlab.approve_group_access_request(1, 1)
+    #    Gitlab.approve_group_access_request(1, 1, {access_level: '30'})
+    #
+    # @param  [Integer, String] :group(required) The ID or name of a group.
+    # @param  [Integer] :user_id(required) The user ID of the access requester
+    # @option options [Integer] :access_level(optional) A valid access level (defaults: 30, developer access level)
+    # @return <Gitlab::ObjectifiedHash] Information about the approved group access request
+    def approve_group_access_request(group, user_id, options = {})
+      put("/groups/#{url_encode group}/access_requests/#{user_id}/approve", body: options)
+    end
+
+    # Denies a project access request for the given user.
+    #
+    # @example
+    #    Gitlab.deny_project_access_request(1, 1)
+    #
+    # @param  [Integer, String] :project(required) The ID or name of a project.
+    # @param  [Integer] :user_id(required) The user ID of the access requester
+    # @return [void] This API call returns an empty response body.
+    def deny_project_access_request(project, user_id)
+      delete("/projects/#{url_encode project}/access_requests/#{user_id}")
+    end
+
+    # Denies a group access request for the given user.
+    #
+    # @example
+    #    Gitlab.deny_group_access_request(1, 1)
+    #
+    # @param  [Integer, String] :group(required) The ID or name of a group.
+    # @param  [Integer] :user_id(required) The user ID of the access requester
+    # @return [void] This API call returns an empty response body.
+    def deny_group_access_request(group, user_id)
+      delete("/groups/#{url_encode group}/access_requests/#{user_id}")
+    end
+  end
+end

data/lib/gitlab/client/application_settings.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to application settings.
+  # @see https://docs.gitlab.com/ee/api/settings.html
+  module ApplicationSettings
+    # Retrives the application settings of Gitlab.
+    #
+    # @example
+    #   Gitlab.application_settings
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def application_settings
+      get('/application/settings')
+    end
+
+    # Edit the applications settings of Gitlab.
+    #
+    # @example
+    #   Gitlab.edit_application_settings({ signup_enabled: false })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :admin_notification_email
+    # @option options [String] :after_sign_out_path
+    # @option options [String] :after_sign_up_text
+    # @option options [String] :akismet_api_key
+    # @option options [Boolean] :akismet_enabled
+    # @option options [Boolean] :allow_group_owners_to_manage_ldap
+    # @option options [Boolean] :allow_local_requests_from_hooks_and_services
+    # @option options [Boolean] :authorized_keys_enabled
+    # @option options [String] :auto_devops_domain
+    # @option options [Boolean] :auto_devops_enabled
+    # @option options [Boolean] :check_namespace_plan
+    # @option options [String] :clientside_sentry_dsn
+    # @option options [Boolean] :clientside_sentry_enabled
+    # @option options [Integer] :container_registry_token_expire_delay
+    # @option options [String] :default_artifacts_expire_in
+    # @option options [Integer] :default_branch_protection
+    # @option options [String] :default_group_visibility
+    # @option options [String] :default_project_visibility
+    # @option options [Integer] :default_projects_limit
+    # @option options [String] :default_snippet_visibility
+    # @option options [Array<String>] :disabled_oauth_sign_in_sources
+    # @option options [Array<String>] :domain_blacklist
+    # @option options [Boolean] :domain_blacklist_enabled
+    # @option options [Array<String>] :domain_whitelist
+    # @option options [Integer] :dsa_key_restriction
+    # @option options [Integer] :ecdsa_key_restriction
+    # @option options [Integer] :ed25519_key_restriction
+    # @option options [Boolean] :elasticsearch_aws
+    # @option options [String] :elasticsearch_aws_access_key
+    # @option options [String] :elasticsearch_aws_region
+    # @option options [String] :elasticsearch_aws_secret_access_key
+    # @option options [Boolean] :elasticsearch_experimental_indexer
+    # @option options [Boolean] :elasticsearch_indexing
+    # @option options [Boolean] :elasticsearch_search
+    # @option options [String] :elasticsearch_url
+    # @option options [Boolean] :elasticsearch_limit_indexing
+    # @option options [Array<Integer>] :elasticsearch_project_ids
+    # @option options [Array<Integer>] :elasticsearch_namespace_ids
+    # @option options [String] :email_additional_text
+    # @option options [Boolean] :email_author_in_body
+    # @option options [String] :enabled_git_access_protocol
+    # @option options [Boolean] :enforce_terms
+    # @option options [String] :external_auth_client_cert
+    # @option options [String] :external_auth_client_key
+    # @option options [String] :external_auth_client_key_pass
+    # @option options [Boolean] :external_authorization_service_enabled
+    # @option options [String] :external_authorization_service_default_label
+    # @option options [Float] :external_authorization_service_timeout float
+    # @option options [String] :external_authorization_service_url
+    # @option options [Integer] :file_template_project_id
+    # @option options [Integer] :first_day_of_week
+    # @option options [Integer] :geo_status_timeout
+    # @option options [Integer] :gitaly_timeout_default
+    # @option options [Integer] :gitaly_timeout_fast
+    # @option options [Integer] :gitaly_timeout_medium
+    # @option options [Boolean] :gravatar_enabled
+    # @option options [Boolean] :hashed_storage_enabled
+    # @option options [Boolean] :help_page_hide_commercial_content
+    # @option options [String] :help_page_support_url
+    # @option options [String] :help_page_text
+    # @option options [String] :help_text
+    # @option options [Boolean] :hide_third_party_offers
+    # @option options [String] :home_page_url
+    # @option options [Boolean] :housekeeping_bitmaps_enabled
+    # @option options [Boolean] :housekeeping_enabled
+    # @option options [Integer] :housekeeping_full_repack_period
+    # @option options [Integer] :housekeeping_gc_period
+    # @option options [Integer] :housekeeping_incremental_repack_period
+    # @option options [Boolean] :html_emails_enabled
+    # @option options [Boolean] :instance_statistics_visibility_private
+    # @option options [Array<String>] :import_sources
+    # @option options [Integer] :max_artifacts_size
+    # @option options [Integer] :max_attachment_size
+    # @option options [Integer] :max_pages_size
+    # @option options [Boolean] :metrics_enabled
+    # @option options [String] :metrics_host
+    # @option options [Integer] :metrics_method_call_threshold
+    # @option options [Integer] :metrics_packet_size
+    # @option options [Integer] :metrics_pool_size
+    # @option options [Integer] :metrics_port
+    # @option options [Integer] :metrics_sample_interval
+    # @option options [Integer] :metrics_timeout
+    # @option options [Boolean] :mirror_available
+    # @option options [Integer] :mirror_capacity_threshold
+    # @option options [Integer] :mirror_max_capacity
+    # @option options [Integer] :mirror_max_delay
+    # @option options [Boolean] :pages_domain_verification_enabled
+    # @option options [Boolean] :password_authentication_enabled_for_git
+    # @option options [Boolean] :password_authentication_enabled_for_web
+    # @option options [String] :performance_bar_allowed_group_id
+    # @option options [String] :performance_bar_allowed_group_path
+    # @option options [Boolean] :performance_bar_enabled
+    # @option options [Boolean] :plantuml_enabled
+    # @option options [String] :plantuml_url
+    # @option options [Float] :polling_interval_multiplier
+    # @option options [Boolean] :project_export_enabled
+    # @option options [Boolean] :prometheus_metrics_enabled
+    # @option options [Boolean] :pseudonymizer_enabled
+    # @option options [Boolean] :recaptcha_enabled
+    # @option options [String] :recaptcha_private_key
+    # @option options [String] :recaptcha_site_key
+    # @option options [Boolean] :repository_checks_enabled
+    # @option options [Integer] :repository_size_limit
+    # @option options [Array<String>] :repository_storages
+    # @option options [Boolean] :require_two_factor_authentication
+    # @option options [Array<String>] :restricted_visibility_levels
+    # @option options [Integer] :rsa_key_restriction
+    # @option options [Boolean] :send_user_confirmation_email
+    # @option options [String] :sentry_dsn
+    # @option options [Boolean] :sentry_enabled
+    # @option options [Integer] :session_expire_delay
+    # @option options [Boolean] :shared_runners_enabled
+    # @option options [Integer] :shared_runners_minutes
+    # @option options [String] :shared_runners_text
+    # @option options [String] :sign_in_text
+    # @option options [String] :signin_enabled
+    # @option options [Boolean] :signup_enabled
+    # @option options [Boolean] :slack_app_enabled
+    # @option options [String] :slack_app_id
+    # @option options [String] :slack_app_secret
+    # @option options [String] :slack_app_verification_token
+    # @option options [Integer] :terminal_max_session_time
+    # @option options [String] :terms
+    # @option options [Boolean] :throttle_authenticated_api_enabled
+    # @option options [Integer] :throttle_authenticated_api_period_in_seconds
+    # @option options [Integer] :throttle_authenticated_api_requests_per_period
+    # @option options [Boolean] :throttle_authenticated_web_enabled
+    # @option options [Integer] :throttle_authenticated_web_period_in_seconds
+    # @option options [Integer] :throttle_authenticated_web_requests_per_period
+    # @option options [Boolean] :throttle_unauthenticated_enabled
+    # @option options [Integer] :throttle_unauthenticated_period_in_seconds
+    # @option options [Integer] :throttle_unauthenticated_requests_per_period
+    # @option options [Integer] :two_factor_grace_period
+    # @option options [Boolean] :unique_ips_limit_enabled
+    # @option options [Integer] :unique_ips_limit_per_user
+    # @option options [Integer] :unique_ips_limit_time_window
+    # @option options [Boolean] :usage_ping_enabled
+    # @option options [Boolean] :user_default_external
+    # @option options [Boolean] :user_oauth_applications
+    # @option options [Boolean] :user_show_add_ssh_key_message
+    # @option options [Boolean] :version_check_enabled
+    # @option options [Integer] :local_markdown_version
+    # @option options [String] :geo_node_allowed_ips
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def edit_application_settings(options = {})
+      put('/application/settings', body: options)
+    end
+  end
+end

data/lib/gitlab/client/avatar.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to avatar.
+  # @see https://docs.gitlab.com/ce/api/avatar.html
+  module Avatar
+    # Get a single avatar URL for a user with the given email address.
+    #
+    # @example
+    #   Gitlab.avatar(email: 'admin@example.com')
+    #   Gitlab.avatar(email: 'admin@example.com', size: 32)
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :email(required) Public email address of the user.
+    # @option options [Integer] :size(optional) Single pixel dimension (since images are squares). Only used for avatar lookups at Gravatar or at the configured Libravatar server.
+    # @return <Gitlab::ObjectifiedHash>
+    def avatar(options = {})
+      get('/avatar', query: options)
+    end
+  end
+end

data/lib/gitlab/client/award_emojis.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to Award Emojis.
   # @see https://docs.gitlab.com/ce/api/award_emoji.html
@@ -79,7 +81,7 @@ class Gitlab::Client
     # @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})
+      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)
@@ -96,7 +98,7 @@ class Gitlab::Client
     # @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})
+      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)
@@ -132,4 +134,4 @@ class Gitlab::Client
       delete("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji/#{award_id}")
     end
   end
-end
+end

data/lib/gitlab/client/boards.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to issue boards.
   # @see https://docs.gitlab.com/ce/api/boards.html
@@ -13,10 +15,66 @@ class Gitlab::Client
     # @option options [Integer] :page The page number.
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def boards(project, options={})
+    def boards(project, options = {})
       get("/projects/#{url_encode project}/boards", query: options)
     end
 
+    # Get a single board.
+    #
+    # @example
+    #   Gitlab.board(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a board.
+    # @return [Gitlab::ObjectifiedHash] Returns information about the board
+    def board(project, id)
+      get("/projects/#{url_encode project}/boards/#{id}")
+    end
+
+    # Creates a new board.
+    #
+    # @example
+    #   Gitlab.create_board(5, 'newboard')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] name The name of the new board.
+    # @return [Gitlab::ObjectifiedHash] Information about created board.
+    def create_board(project, name)
+      body = { name: name }
+      post("/projects/#{url_encode project}/boards", body: body)
+    end
+
+    # Updates a board.
+    #
+    # @example
+    #   Gitlab.edit_board(5, 1, name: 'new_name')
+    #   Gitlab.edit_board(5, 1, name: 'new_name', assignee_id: 1, milestone_id: 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a board.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :name(optional) The new name of the board.
+    # @option options [Integer] :assignee_id(optional) The assignee the board should be scoped to.
+    # @option options [Integer] :milestone_id(optional) The milestone the board should be scoped to.
+    # @option options [String] :labels(optional) Comma-separated list of label names which the board should be scoped to.
+    # @option options [Integer] :weight(optional) The weight range from 0 to 9, to which the board should be scoped to.
+    # @return [Gitlab::ObjectifiedHash] Information about updated board.
+    def edit_board(project, id, options = {})
+      put("/projects/#{url_encode project}/boards/#{id}", body: options)
+    end
+
+    # Deletes a board.
+    #
+    # @example
+    #   Gitlab.delete_board(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a board.
+    # @return [void] This API call returns an empty response body.
+    def delete_board(project, id)
+      delete("/projects/#{url_encode project}/boards/#{id}")
+    end
+
     # Gets a board lists
     #
     # @example
@@ -28,6 +86,7 @@ class Gitlab::Client
     def board_lists(project, id)
       get("/projects/#{url_encode project}/boards/#{id}/lists")
     end
+
     #
     # Gets a single board list
     #
@@ -53,7 +112,7 @@ class Gitlab::Client
     # @param  [Integer] label_id The ID of a label.
     # @return [Gitlab::ObjectifiedHash] Information about created list.
     def create_board_list(project, board_id, label_id)
-      post("/projects/#{url_encode project}/boards/#{board_id}/lists", body: {label_id: label_id})
+      post("/projects/#{url_encode project}/boards/#{board_id}/lists", body: { label_id: label_id })
     end
 
     # Updates a board list.
@@ -67,7 +126,7 @@ class Gitlab::Client
     # @param  [Integer] id The ID of a list.
     # @return [Gitlab::ObjectifiedHash] Information about updated board list.
     def edit_board_list(project, board_id, id, position)
-      put("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}", body: {position: position})
+      put("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}", body: { position: position })
     end
 
     # Deletes  a board list.
@@ -85,4 +144,3 @@ class Gitlab::Client
     end
   end
 end
-

data/lib/gitlab/client/branches.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to repositories.
   # @see https://docs.gitlab.com/ce/api/branches.html
@@ -12,10 +14,10 @@ class Gitlab::Client
     # @option options [Integer] :page The page number.
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def branches(project, options={})
+    def branches(project, options = {})
       get("/projects/#{url_encode project}/repository/branches", query: options)
     end
-    alias_method :repo_branches, :branches
+    alias repo_branches branches
 
     # Gets information about a repository branch.
     #
@@ -27,9 +29,9 @@ class Gitlab::Client
     # @param  [String] branch The name of the branch.
     # @return [Gitlab::ObjectifiedHash]
     def branch(project, branch)
-      get("/projects/#{url_encode project}/repository/branches/#{branch}")
+      get("/projects/#{url_encode project}/repository/branches/#{url_encode branch}")
     end
-    alias_method :repo_branch, :branch
+    alias repo_branch branch
 
     # Protects a repository branch.
     #
@@ -47,9 +49,9 @@ class Gitlab::Client
     # @option options [Boolean] :developers_can_merge True to allow developers to merge into the branch (default = false)
     # @return [Gitlab::ObjectifiedHash] Details about the branch
     def protect_branch(project, branch, options = {})
-      put("/projects/#{url_encode project}/repository/branches/#{branch}/protect", body: options)
+      post("/projects/#{url_encode project}/protected_branches", body: { name: branch }.merge(options))
     end
-    alias_method :repo_protect_branch, :protect_branch
+    alias repo_protect_branch protect_branch
 
     # Unprotects a repository branch.
     #
@@ -61,24 +63,24 @@ class Gitlab::Client
     # @param  [String] branch The name of the branch.
     # @return [Gitlab::ObjectifiedHash] Details about the branch
     def unprotect_branch(project, branch)
-      put("/projects/#{url_encode project}/repository/branches/#{branch}/unprotect")
+      delete("/projects/#{url_encode project}/protected_branches/#{url_encode branch}")
     end
-    alias_method :repo_unprotect_branch, :unprotect_branch
+    alias repo_unprotect_branch unprotect_branch
 
     # Creates a repository branch.  Requires Gitlab >= 6.8.x
     #
     # @example
-    #   Gitlab.create_branch(3, 'api')
-    #   Gitlab.repo_create_branch(5, 'master')
+    #   Gitlab.create_branch(3, 'api', 'feat/new-api')
+    #   Gitlab.repo_create_branch(5, 'master', 'develop')
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the new branch.
     # @param  [String] ref Create branch from commit sha or existing branch
     # @return [Gitlab::ObjectifiedHash] Details about the branch
     def create_branch(project, branch, ref)
-      post("/projects/#{url_encode project}/repository/branches", body: { branch: branch, ref: ref })
+      post("/projects/#{url_encode project}/repository/branches", query: { branch: branch, ref: ref })
     end
-    alias_method :repo_create_branch, :create_branch
+    alias repo_create_branch create_branch
 
     # Deletes a repository branch.  Requires Gitlab >= 6.8.x
     #
@@ -89,8 +91,45 @@ class Gitlab::Client
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the branch to delete
     def delete_branch(project, branch)
-      delete("/projects/#{url_encode project}/repository/branches/#{branch}")
+      delete("/projects/#{url_encode project}/repository/branches/#{url_encode branch}")
+    end
+    alias repo_delete_branch delete_branch
+
+    # Delete all branches that are merged into the project default branch. Protected branches will not be deleted as part of this operation.
+    #
+    # @example
+    #   Gitlab.delete_merged_branches(3)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @return [nil] This API call returns an empty response body.
+    def delete_merged_branches(project)
+      delete("/projects/#{url_encode project}/repository/merged_branches")
+    end
+    alias repo_delete_merged_branches delete_merged_branches
+
+    # Gets a list of protected branches from a project.
+    #
+    # @example
+    #   Gitlab.protected_branches(42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def protected_branches(project)
+      get("/projects/#{url_encode project}/protected_branches")
+    end
+    alias repo_protected_branches protected_branches
+
+    # Gets a single protected branch or wildcard protected branch
+    #
+    # @example
+    #   Gitlab.protected_branch(3, 'api')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] name The name of the branch or wildcard
+    # @return [Gitlab::ObjectifiedHash]
+    def protected_branch(project, branch)
+      get("/projects/#{url_encode project}/protected_branches/#{url_encode branch}")
     end
-    alias_method :repo_delete_branch, :delete_branch
+    alias repo_protected_branch protected_branch
   end
 end

data/lib/gitlab/client/broadcast_messages.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to broadcast messages (only accessible to administrators).
+  # @see https://docs.gitlab.com/ce/api/broadcast_messages.html
+  module BroadcastMessages
+    # Get all broadcast messages
+    #
+    # @example
+    #   Gitlab.broadcast_messages
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def broadcast_messages
+      get('/broadcast_messages')
+    end
+
+    # Get a specific broadcast message
+    #
+    # @example
+    #   Gitlab.broadcast_message(3)
+    #
+    # @param  [Integer] id The ID of broadcast message
+    # @return [Gitlab::ObjectifiedHash]
+    def broadcast_message(id)
+      get("/broadcast_messages/#{id}")
+    end
+
+    # Create a broadcast message.
+    #
+    # @example
+    #   Gitlab.create_broadcast_message('Mayday')
+    #   Gitlab.create_broadcast_message('Mayday', {starts_at: Time.zone.now, ends_at: Time.zone.now + 30.minutes, color: '#cecece', font: '#FFFFFF'})
+    #
+    # @param  [String] message Message to display
+    # @param  [Hash] options A customizable set of options.
+    # @option options [DateTime] :starts_at(optional) Starting time (defaults to current time)
+    # @option options [DateTime] :ends_at(optional) Ending time (defaults to one hour from current time)
+    # @option options [String] :color(optional) Background color hex code
+    # @option options [String] :font(optional) Foreground color hex code
+    # @return [Gitlab::ObjectifiedHash] Information about created broadcast message.
+    def create_broadcast_message(message, options = {})
+      body = { message: message }.merge(options)
+      post('/broadcast_messages', body: body)
+    end
+
+    # Update a broadcast message
+    #
+    # @example
+    #   Gitlab.edit_broadcast_message(6, { message: 'No Mayday' })
+    #   Gitlab.edit_broadcast_message(6, { font: '#FEFEFE' })
+    #
+    # @param  [Integer] id The ID of a broadcast message
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :message(optional) Message to display
+    # @option options [DateTime] :starts_at(optional) Starting time (defaults to current time)
+    # @option options [DateTime] :ends_at(optional) Ending time (defaults to one hour from current time)
+    # @option options [String] :color(optional) Background color hex code
+    # @option options [String] :font(optional) Foreground color hex code
+    # @return [Gitlab::ObjectifiedHash] Information about updated broadcast message.
+    def edit_broadcast_message(id, options = {})
+      put("/broadcast_messages/#{id}", body: options)
+    end
+
+    # Delete a broadcast message.
+    #
+    # @example
+    #   Gitlab.delete_broadcast_message(3)
+    #
+    # @param  [Integer] id The ID of a broadcast message.
+    # @return [nil] This API call returns an empty response body.
+    def delete_broadcast_message(id)
+      delete("/broadcast_messages/#{id}")
+    end
+  end
+end