# frozen_string_literal: true module API class Invitations < ::API::Base include PaginationParams feature_category :users before { authenticate! } helpers ::API::Helpers::MembersHelpers %w[group project].each do |source_type| params do requires :id, type: String, desc: "The #{source_type} ID" end resource source_type.pluralize, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do desc 'Invite non-members by email address to a group or project.' do detail 'This feature was introduced in GitLab 13.6' success Entities::Invitation end params do requires :access_level, type: Integer, values: Gitlab::Access.all_values, desc: 'A valid access level (defaults: `30`, developer access level)' optional :email, type: Array[String], email_or_email_list: true, coerce_with: ::API::Validations::Types::CommaSeparatedToArray.coerce, desc: 'The email address to invite, or multiple emails separated by comma' optional :user_id, type: Array[String], coerce_with: ::API::Validations::Types::CommaSeparatedToArray.coerce, desc: 'The user ID of the new member or multiple IDs separated by commas.' optional :expires_at, type: DateTime, desc: 'Date string in the format YEAR-MONTH-DAY' optional :invite_source, type: String, desc: 'Source that triggered the member creation process', default: 'invitations-api' optional :tasks_to_be_done, type: Array[String], coerce_with: Validations::Types::CommaSeparatedToArray.coerce, desc: 'Tasks the inviter wants the member to do' optional :tasks_project_id, type: Integer, desc: 'The project ID in which to create the task issues' end post ":id/invitations", urgency: :low do ::Gitlab::QueryLimiting.disable!('https://gitlab.com/gitlab-org/gitlab/-/issues/354016') bad_request!('Must provide either email or user_id as a parameter') if params[:email].blank? && params[:user_id].blank? source = find_source(source_type, params[:id]) authorize_admin_source!(source_type, source) create_service_params = params.merge(source: source) ::Members::InviteService.new(current_user, create_service_params).execute end desc 'Get a list of group or project invitations viewable by the authenticated user' do detail 'This feature was introduced in GitLab 13.6' success Entities::Invitation end params do optional :query, type: String, desc: 'A query string to search for members' use :pagination end get ":id/invitations" do source = find_source(source_type, params[:id]) query = params[:query] authorize_admin_source!(source_type, source) invitations = paginate(retrieve_member_invitations(source, query)) present_member_invitations invitations end desc 'Updates a group or project invitation.' do success Entities::Member end params do requires :email, type: String, desc: 'The email address of the invitation' optional :access_level, type: Integer, values: Gitlab::Access.all_values, desc: 'A valid access level (defaults: `30`, developer access level)' optional :expires_at, type: DateTime, desc: 'Date string in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`)' end put ":id/invitations/:email", requirements: { email: %r{[^/]+} } do source = find_source(source_type, params.delete(:id)) invite_email = params[:email] authorize_admin_source!(source_type, source) invite = retrieve_member_invitations(source, invite_email).first not_found! unless invite update_params = declared_params(include_missing: false) update_params.delete(:email) bad_request! unless update_params.any? result = ::Members::UpdateService .new(current_user, update_params) .execute(invite) updated_member = result[:member] if result[:status] == :success present_members updated_member else render_validation_error!(updated_member) end end desc 'Removes an invitation from a group or project.' params do requires :email, type: String, desc: 'The email address of the invitation' end delete ":id/invitations/:email", requirements: { email: %r{[^/]+} } do source = find_source(source_type, params[:id]) invite_email = params[:email] authorize_admin_source!(source_type, source) invite = retrieve_member_invitations(source, invite_email).first not_found! unless invite destroy_conditionally!(invite) do ::Members::DestroyService.new(current_user, params).execute(invite) unprocessable_entity! unless invite.destroyed? end end end end end end