module Yammer
  module Api
    module Notification

      # @see https://developer.yammer.com/restapi/#rest-search
      # @api_path /api/v1/streams/notifications
      # @rate_limited Yes
      # @authentication authenticated user context
      # @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
      # @return [Yammer::ApiResponse]
      # @example Fetch notifications for authenticated user
      #   Yammer.notifications
      def notifications
        get('/api/v1/streams/notifications')
      end
    end
  end
end