slack-api 1.6.0 → 1.6.1

data/lib/slack/endpoint/reminders.rb

@@ -4,7 +4,7 @@ module Slack
   module Endpoint
     module Reminders
       #
-      # This method creates a reminder.
+      # Creates a reminder.
       #
       # @option options [Object] :text
       #   The content of the reminder
@@ -22,7 +22,7 @@ module Slack
       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
@@ -35,7 +35,7 @@ module Slack
       end
 
       #
-      # This method deletes a reminder.
+      # Deletes a reminder.
       #
       # @option options [Object] :reminder
       #   The ID of the reminder
@@ -48,7 +48,7 @@ module Slack
       end
 
       #
-      # This method returns information about a reminder.
+      # Gets information about a reminder.
       #
       # @option options [Object] :reminder
       #   The ID of the reminder
@@ -61,7 +61,7 @@ module Slack
       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/aki017/slack-api-docs/blob/master/methods/reminders.list.md

data/lib/slack/endpoint/search.rb

@@ -4,20 +4,20 @@ module Slack
   module Endpoint
     module Search
       #
-      # This method allows users and applications to search both messages and files in a single call.
+      # Searches for messages and files matching a query.
       #
       # @option options [Object] :query
       #   Search query. May contains booleans, etc.
-      # @option options [Object] :sort
-      #   Return matches sorted by either score or timestamp.
-      # @option options [Object] :sort_dir
-      #   Change sort direction to ascending (asc) or descending (desc).
-      # @option options [Object] :highlight
-      #   Pass a value of true to enable query highlight markers (see below).
       # @option options [Object] :count
       #   Number of items to return per page.
+      # @option options [Object] :highlight
+      #   Pass a value of true to enable query highlight markers (see below).
       # @option options [Object] :page
       #   Page number of results to return.
+      # @option options [Object] :sort
+      #   Return matches sorted by either score or timestamp.
+      # @option options [Object] :sort_dir
+      #   Change sort direction to ascending (asc) or descending (desc).
       # @see https://api.slack.com/methods/search.all
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/search.all.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/search.all.json
@@ -27,20 +27,20 @@ module Slack
       end
 
       #
-      # This method returns files matching a search query.
+      # Searches for files matching a query.
       #
       # @option options [Object] :query
       #   Search query. May contain booleans, etc.
-      # @option options [Object] :sort
-      #   Return matches sorted by either score or timestamp.
-      # @option options [Object] :sort_dir
-      #   Change sort direction to ascending (asc) or descending (desc).
-      # @option options [Object] :highlight
-      #   Pass a value of true to enable query highlight markers (see below).
       # @option options [Object] :count
       #   Number of items to return per page.
+      # @option options [Object] :highlight
+      #   Pass a value of true to enable query highlight markers (see below).
       # @option options [Object] :page
       #   Page number of results to return.
+      # @option options [Object] :sort
+      #   Return matches sorted by either score or timestamp.
+      # @option options [Object] :sort_dir
+      #   Change sort direction to ascending (asc) or descending (desc).
       # @see https://api.slack.com/methods/search.files
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/search.files.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/search.files.json
@@ -50,20 +50,20 @@ module Slack
       end
 
       #
-      # This method returns messages matching a search query.
+      # Searches for messages matching a query.
       #
       # @option options [Object] :query
       #   Search query. May contains booleans, etc.
-      # @option options [Object] :sort
-      #   Return matches sorted by either score or timestamp.
-      # @option options [Object] :sort_dir
-      #   Change sort direction to ascending (asc) or descending (desc).
+      # @option options [Object] :count
+      #   Pass the number of results you want per "page". Maximum of 100.
       # @option options [Object] :highlight
       #   Pass a value of true to enable query highlight markers (see below).
-      # @option options [Object] :count
-      #   Number of items to return per page.
       # @option options [Object] :page
       #   Page number of results to return.
+      # @option options [Object] :sort
+      #   Return matches sorted by either score or timestamp.
+      # @option options [Object] :sort_dir
+      #   Change sort direction to ascending (asc) or descending (desc).
       # @see https://api.slack.com/methods/search.messages
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/search.messages.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/search.messages.json

data/lib/slack/endpoint/stars.rb

@@ -4,15 +4,14 @@ module Slack
   module Endpoint
     module Stars
       #
-      # This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.
-      # One of file, file_comment, channel, or the combination of channel and timestamp must be specified.
+      # Adds a star to an item.
       #
+      # @option options [Object] :channel
+      #   Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
       # @option options [Object] :file
       #   File to add star to.
       # @option options [Object] :file_comment
       #   File comment to add star to.
-      # @option options [Object] :channel
-      #   Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
       # @option options [Object] :timestamp
       #   Timestamp of the message to add star to.
       # @see https://api.slack.com/methods/stars.add
@@ -23,7 +22,7 @@ module Slack
       end
 
       #
-      # This method lists the items starred by the authed user.
+      # Lists stars for a user.
       #
       # @option options [Object] :count
       #   Number of items to return per page.
@@ -37,15 +36,14 @@ module Slack
       end
 
       #
-      # This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.
-      # One of file, file_comment, channel, or the combination of channel and timestamp must be specified.
+      # Removes a star from an item.
       #
+      # @option options [Object] :channel
+      #   Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).
       # @option options [Object] :file
       #   File to remove star from.
       # @option options [Object] :file_comment
       #   File comment to remove star from.
-      # @option options [Object] :channel
-      #   Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).
       # @option options [Object] :timestamp
       #   Timestamp of the message to remove star from.
       # @see https://api.slack.com/methods/stars.remove

data/lib/slack/endpoint/team.rb

@@ -4,14 +4,14 @@ module Slack
   module Endpoint
     module Team
       #
-      # This method is used to get the access logs for users on a team.
+      # Gets the access logs for the current team.
       #
+      # @option options [Object] :before
+      #   End of time range of logs to include in results (inclusive).
       # @option options [Object] :count
       #   Number of items to return per page.
       # @option options [Object] :page
       #   Page number of results to return.
-      # @option options [Object] :before
-      #   End of time range of logs to include in results (inclusive).
       # @see https://api.slack.com/methods/team.accessLogs
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/team.accessLogs.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/team.accessLogs.json
@@ -20,8 +20,7 @@ module Slack
       end
 
       #
-      # This method lists billable information for each user on the team. Currently this consists solely of whether the user is
-      # subject to billing per Slack's Fair Billing policy.
+      # Gets billable users information for the current team.
       #
       # @option options [Object] :user
       #   A user to retrieve the billable information for. Defaults to all users.
@@ -33,7 +32,7 @@ module Slack
       end
 
       #
-      # This method provides information about your team.
+      # Gets information about the current team.
       #
       # @see https://api.slack.com/methods/team.info
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/team.info.md
@@ -43,20 +42,20 @@ module Slack
       end
 
       #
-      # This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins.
+      # Gets the integration logs for the current team.
       #
-      # @option options [Object] :service_id
-      #   Filter logs to this service. Defaults to all logs.
       # @option options [Object] :app_id
       #   Filter logs to this Slack app. Defaults to all logs.
-      # @option options [Object] :user
-      #   Filter logs generated by this user’s actions. Defaults to all logs.
       # @option options [Object] :change_type
       #   Filter logs with this change type. Defaults to all logs.
       # @option options [Object] :count
       #   Number of items to return per page.
       # @option options [Object] :page
       #   Page number of results to return.
+      # @option options [Object] :service_id
+      #   Filter logs to this service. Defaults to all logs.
+      # @option options [Object] :user
+      #   Filter logs generated by this user’s actions. Defaults to all logs.
       # @see https://api.slack.com/methods/team.integrationLogs
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/team.integrationLogs.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/team.integrationLogs.json
@@ -65,7 +64,7 @@ module Slack
       end
 
       #
-      # This method is used to get the profile field definitions for this team.
+      # Retrieve a team's profile.
       #
       # @option options [Object] :visibility
       #   Filter by visibility.

data/lib/slack/endpoint/usergroups.rb

@@ -4,16 +4,16 @@ module Slack
   module Endpoint
     module Usergroups
       #
-      # This method is used to create a User Group.
+      # Create a User Group
       #
       # @option options [Object] :name
       #   A name for the User Group. Must be unique among User Groups.
-      # @option options [Object] :handle
-      #   A mention handle. Must be unique among channels, users and User Groups.
-      # @option options [Object] :description
-      #   A short description of the User Group.
       # @option options [Object] :channels
       #   A comma separated string of encoded channel IDs for which the User Group uses as a default.
+      # @option options [Object] :description
+      #   A short description of the User Group.
+      # @option options [Object] :handle
+      #   A mention handle. Must be unique among channels, users and User Groups.
       # @option options [Object] :include_count
       #   Include the number of users in each User Group.
       # @see https://api.slack.com/methods/usergroups.create
@@ -25,7 +25,7 @@ module Slack
       end
 
       #
-      # This method disables an existing User Group.
+      # Disable an existing User Group
       #
       # @option options [Object] :usergroup
       #   The encoded ID of the User Group to disable.
@@ -40,7 +40,7 @@ module Slack
       end
 
       #
-      # This method enables a User Group which was previously disabled.
+      # Enable a User Group
       #
       # @option options [Object] :usergroup
       #   The encoded ID of the User Group to enable.
@@ -55,12 +55,12 @@ module Slack
       end
 
       #
-      # This method returns a list of all User Groups in the team. This can optionally include disabled User Groups.
+      # List all User Groups for a team
       #
-      # @option options [Object] :include_disabled
-      #   Include disabled User Groups.
       # @option options [Object] :include_count
       #   Include the number of users in each User Group.
+      # @option options [Object] :include_disabled
+      #   Include disabled User Groups.
       # @option options [Object] :include_users
       #   Include the list of users for each User Group.
       # @see https://api.slack.com/methods/usergroups.list
@@ -71,20 +71,20 @@ module Slack
       end
 
       #
-      # This method updates the properties of an existing User Group.
+      # Update an existing User Group
       #
       # @option options [Object] :usergroup
       #   The encoded ID of the User Group to update.
-      # @option options [Object] :name
-      #   A name for the User Group. Must be unique among User Groups.
-      # @option options [Object] :handle
-      #   A mention handle. Must be unique among channels, users and User Groups.
-      # @option options [Object] :description
-      #   A short description of the User Group.
       # @option options [Object] :channels
       #   A comma separated string of encoded channel IDs for which the User Group uses as a default.
+      # @option options [Object] :description
+      #   A short description of the User Group.
+      # @option options [Object] :handle
+      #   A mention handle. Must be unique among channels, users and User Groups.
       # @option options [Object] :include_count
       #   Include the number of users in the User Group.
+      # @option options [Object] :name
+      #   A name for the User Group. Must be unique among User Groups.
       # @see https://api.slack.com/methods/usergroups.update
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.update.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.update.json
@@ -94,7 +94,7 @@ module Slack
       end
 
       #
-      # This method returns a list of all users within a User Group.
+      # List all users in a User Group
       #
       # @option options [Object] :usergroup
       #   The encoded ID of the User Group to update.
@@ -109,7 +109,7 @@ module Slack
       end
 
       #
-      # This method updates the list of users that belong to a User Group. This method replaces all users in a User Group with the list of users provided in the users parameter.
+      # Update the list of users for a User Group
       #
       # @option options [Object] :usergroup
       #   The encoded ID of the User Group to update.

data/lib/slack/endpoint/users.rb

@@ -4,7 +4,7 @@ module Slack
   module Endpoint
     module Users
       #
-      # This method allows the user to delete their profile image. It will clear whatever image is currently set.
+      # Delete the user profile photo
       #
       # @see https://api.slack.com/methods/users.deletePhoto
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.deletePhoto.md
@@ -14,8 +14,7 @@ module Slack
       end
 
       #
-      # This method lets you find out information about a user's presence.
-      # Consult the presence documentation for more details.
+      # Gets user presence information.
       #
       # @option options [Object] :user
       #   User to get presence info on. Defaults to the authed user.
@@ -28,7 +27,7 @@ module Slack
       end
 
       #
-      # After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity.
+      # Get a user's identity.
       #
       # @see https://api.slack.com/methods/users.identity
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.identity.md
@@ -38,10 +37,12 @@ module Slack
       end
 
       #
-      # This method returns information about a team member.
+      # Gets information about a user.
       #
       # @option options [Object] :user
       #   User to get info on
+      # @option options [Object] :include_locale
+      #   Set this to true to receive the locale for this user. Defaults to false
       # @see https://api.slack.com/methods/users.info
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.info.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.info.json
@@ -51,10 +52,16 @@ module Slack
       end
 
       #
-      # This method returns a list of all users in the team. This includes deleted/deactivated users.
+      # Lists all users in a Slack team.
       #
+      # @option options [Object] :cursor
+      #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
+      # @option options [Object] :include_locale
+      #   Set this to true to receive the locale for users. Defaults to false
+      # @option options [Object] :limit
+      #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
       # @option options [Object] :presence
-      #   Whether to include presence data in the output
+      #   Whether to include presence data in the output. Defaults to false. Setting this to true reduces performance, especially with large teams.
       # @see https://api.slack.com/methods/users.list
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.list.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.list.json
@@ -63,12 +70,25 @@ module Slack
       end
 
       #
-      # Use this method to retrieve a user's profile information.
+      # Find a user with an email address.
+      #
+      # @option options [Object] :email
+      #   An email address belonging to a user in the workspace
+      # @see https://api.slack.com/methods/users.lookupByEmail
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.lookupByEmail.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.lookupByEmail.json
+      def users_lookupByEmail(options={})
+        throw ArgumentError.new("Required arguments :email missing") if options[:email].nil?
+        post("users.lookupByEmail", options)
+      end
+
+      #
+      # Retrieves a user's profile information.
       #
-      # @option options [Object] :user
-      #   User to retrieve profile info for
       # @option options [Object] :include_labels
       #   Include labels for each ID in custom profile fields
+      # @option options [Object] :user
+      #   User to retrieve profile info for
       # @see https://api.slack.com/methods/users.profile.get
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.profile.get.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.profile.get.json
@@ -77,14 +97,14 @@ module Slack
       end
 
       #
-      # Use this method to set a user's profile information, including name, email, current status, and other attributes.
+      # Set the profile information for a user.
       #
-      # @option options [Object] :user
-      #   ID of user to change. This argument may only be specified by team admins on paid teams.
-      # @option options [Object] :profile
-      #   Collection of key:value pairs presented as a URL-encoded JSON hash.
       # @option options [Object] :name
       #   Name of a single key to set. Usable only if profile is not passed.
+      # @option options [Object] :profile
+      #   Collection of key:value pairs presented as a URL-encoded JSON hash.
+      # @option options [Object] :user
+      #   ID of user to change. This argument may only be specified by team admins on paid teams.
       # @option options [Object] :value
       #   Value to set a single key to. Usable only if profile is not passed.
       # @see https://api.slack.com/methods/users.profile.set
@@ -95,9 +115,7 @@ module Slack
       end
 
       #
-      # This method lets the slack messaging server know that the authenticated user
-      # is currently active. Consult the presence documentation for
-      # more details.
+      # Marks a user as active.
       #
       # @see https://api.slack.com/methods/users.setActive
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.setActive.md
@@ -107,16 +125,16 @@ module Slack
       end
 
       #
-      # This method allows the user to set their profile image. The caller can pass image data via image.
+      # Set the user profile photo
       #
       # @option options [Object] :image
       #   File contents via multipart/form-data.
+      # @option options [Object] :crop_w
+      #   Width/height of crop box (always square)
       # @option options [Object] :crop_x
       #   X coordinate of top-left corner of crop box
       # @option options [Object] :crop_y
       #   Y coordinate of top-left corner of crop box
-      # @option options [Object] :crop_w
-      #   Width/height of crop box (always square)
       # @see https://api.slack.com/methods/users.setPhoto
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.setPhoto.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.setPhoto.json
@@ -126,8 +144,7 @@ module Slack
       end
 
       #
-      # This method lets you set the calling user's manual presence.
-      # Consult the presence documentation for more details.
+      # Manually sets user presence.
       #
       # @option options [Object] :presence
       #   Either auto or away