lib/slack/web/api/endpoints/reminders.rb in slack-ruby-client-0.14.4 vs lib/slack/web/api/endpoints/reminders.rb in slack-ruby-client-0.14.5
- old
+ new
@@ -1,14 +1,15 @@
+# frozen_string_literal: true
# This file was auto-generated by lib/tasks/web.rake
module Slack
module Web
module Api
module Endpoints
module Reminders
#
- # This method creates a reminder.
+ # Creates a reminder.
#
# @option options [Object] :text
# The content of the reminder.
# @option options [Object] :time
# When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday").
@@ -22,11 +23,11 @@
options = options.merge(user: users_id(options)['user']['id']) if options[:user]
post('reminders.add', options)
end
#
- # This method completes a reminder.
+ # Marks a reminder as complete.
#
# @option options [Object] :reminder
# The ID of the reminder to be marked as complete.
# @see https://api.slack.com/methods/reminders.complete
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.complete.json
@@ -34,11 +35,11 @@
throw ArgumentError.new('Required arguments :reminder missing') if options[:reminder].nil?
post('reminders.complete', options)
end
#
- # This method deletes a reminder.
+ # Deletes a reminder.
#
# @option options [Object] :reminder
# The ID of the reminder.
# @see https://api.slack.com/methods/reminders.delete
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.delete.json
@@ -46,11 +47,11 @@
throw ArgumentError.new('Required arguments :reminder missing') if options[:reminder].nil?
post('reminders.delete', options)
end
#
- # This method returns information about a reminder.
+ # Gets information about a reminder.
#
# @option options [Object] :reminder
# The ID of the reminder.
# @see https://api.slack.com/methods/reminders.info
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.info.json
@@ -58,10 +59,10 @@
throw ArgumentError.new('Required arguments :reminder missing') if options[:reminder].nil?
post('reminders.info', options)
end
#
- # This method lists all reminders created by or for a given user.
+ # Lists all reminders created by or for a given user.
#
# @see https://api.slack.com/methods/reminders.list
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.list.json
def reminders_list(options = {})
post('reminders.list', options)