slack-ruby-client 0.14.4 → 0.16.0

data/lib/slack/web/api/endpoints/rtm.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Rtm
           #
-          # This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.
+          # Starts a Real Time Messaging session.
           #
           # @option options [Object] :batch_presence_aware
           #   Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.
@@ -19,7 +20,7 @@ module Slack
           end
 
           #
-          # This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.
+          # Starts a Real Time Messaging session.
           #
           # @option options [Object] :batch_presence_aware
           #   Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.

data/lib/slack/web/api/endpoints/search.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         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.
@@ -16,6 +17,8 @@ module Slack
           #   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] :team_id
+          #   encoded team id to search in, required if org token is used.
           # @see https://api.slack.com/methods/search.all
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/search/search.all.json
           def search_all(options = {})
@@ -24,7 +27,7 @@ module Slack
           end
 
           #
-          # This method returns files matching a search query.
+          # Searches for files matching a query.
           #
           # @option options [Object] :query
           #   Search query.
@@ -34,6 +37,8 @@ module Slack
           #   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] :team_id
+          #   encoded team id to search in, required if org token is used.
           # @see https://api.slack.com/methods/search.files
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/search/search.files.json
           def search_files(options = {})
@@ -42,7 +47,7 @@ module Slack
           end
 
           #
-          # This method returns messages matching a search query.
+          # Searches for messages matching a query.
           #
           # @option options [Object] :query
           #   Search query.
@@ -52,6 +57,8 @@ module Slack
           #   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] :team_id
+          #   encoded team id to search in, required if org token is used.
           # @see https://api.slack.com/methods/search.messages
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/search/search.messages.json
           def search_messages(options = {})

data/lib/slack/web/api/endpoints/stars.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,8 +7,7 @@ module Slack
       module Endpoints
         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 [channel] :channel
           #   Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
@@ -20,12 +20,12 @@ module Slack
           # @see https://api.slack.com/methods/stars.add
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/stars.add.json
           def stars_add(options = {})
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('stars.add', options)
           end
 
           #
-          # This method lists the items starred by the authed user.
+          # Lists stars for a user.
           #
           # @option options [Object] :cursor
           #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
@@ -44,8 +44,7 @@ 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 [channel] :channel
           #   Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).
@@ -58,7 +57,7 @@ module Slack
           # @see https://api.slack.com/methods/stars.remove
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/stars.remove.json
           def stars_remove(options = {})
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('stars.remove', options)
           end
         end

data/lib/slack/web/api/endpoints/team.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,10 +7,12 @@ module Slack
       module Endpoints
         module Team
           #
-          # This method is used to retrieve the "access logs" for users on a workspace.
+          # 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] :team_id
+          #   encoded team id to get logs from, required if org token is used.
           # @see https://api.slack.com/methods/team.accessLogs
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/team/team.accessLogs.json
           def team_accessLogs(options = {})
@@ -17,9 +20,10 @@ 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] :team_id
+          #   encoded team id to get the billable information from, required if org token is used.
           # @option options [user] :user
           #   A user to retrieve the billable information for. Defaults to all users.
           # @see https://api.slack.com/methods/team.billableInfo
@@ -30,7 +34,7 @@ module Slack
           end
 
           #
-          # This method provides information about your team.
+          # Gets information about the current team.
           #
           # @option options [Object] :team
           #   Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels.
@@ -41,7 +45,7 @@ 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] :app_id
           #   Filter logs to this Slack app. Defaults to all logs.
@@ -49,6 +53,8 @@ module Slack
           #   Filter logs with this change type. Defaults to all logs.
           # @option options [Object] :service_id
           #   Filter logs to this service. Defaults to all logs.
+          # @option options [Object] :team_id
+          #   encoded team id to get logs from, required if org token is used.
           # @option options [user] :user
           #   Filter logs generated by this user's actions. Defaults to all logs.
           # @see https://api.slack.com/methods/team.integrationLogs

data/lib/slack/web/api/endpoints/team_profile.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module TeamProfile
           #
-          # 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/web/api/endpoints/usergroups.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         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.
@@ -18,6 +19,8 @@ module Slack
           #   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.
+          # @option options [Object] :team_id
+          #   Encoded team id where the user group has to be created, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.create
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.create.json
           def usergroups_create(options = {})
@@ -26,12 +29,14 @@ 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.
           # @option options [Object] :include_count
           #   Include the number of users in the User Group.
+          # @option options [Object] :team_id
+          #   Encoded team id where the user group is, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.disable
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.disable.json
           def usergroups_disable(options = {})
@@ -40,12 +45,14 @@ 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.
           # @option options [Object] :include_count
           #   Include the number of users in the User Group.
+          # @option options [Object] :team_id
+          #   Encoded team id where the user group is, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.enable
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.enable.json
           def usergroups_enable(options = {})
@@ -54,7 +61,7 @@ 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_count
           #   Include the number of users in each User Group.
@@ -62,6 +69,8 @@ module Slack
           #   Include disabled User Groups.
           # @option options [Object] :include_users
           #   Include the list of users for each User Group.
+          # @option options [Object] :team_id
+          #   encoded team id to list user groups in, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.list.json
           def usergroups_list(options = {})
@@ -69,7 +78,7 @@ 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.
@@ -83,6 +92,8 @@ module Slack
           #   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.
+          # @option options [Object] :team_id
+          #   encoded team id where the user group exists, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.update
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.update.json
           def usergroups_update(options = {})

data/lib/slack/web/api/endpoints/usergroups_users.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,12 +7,14 @@ module Slack
       module Endpoints
         module UsergroupsUsers
           #
-          # 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.
           # @option options [Object] :include_disabled
           #   Allow results that involve disabled User Groups.
+          # @option options [Object] :team_id
+          #   encoded team id where the user group exists, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.users.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups.users/usergroups.users.list.json
           def usergroups_users_list(options = {})
@@ -20,7 +23,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.
@@ -28,6 +31,8 @@ module Slack
           #   A comma separated string of encoded user IDs that represent the entire list of users for the User Group.
           # @option options [Object] :include_count
           #   Include the number of users in the User Group.
+          # @option options [Object] :team_id
+          #   encoded team id where the user group exists, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.users.update
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups.users/usergroups.users.update.json
           def usergroups_users_update(options = {})

data/lib/slack/web/api/endpoints/users.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,11 +7,7 @@ module Slack
       module Endpoints
         module Users
           #
-          # This method helps answer questions like:
-          # - Which conversations am I a member of?
-          # - Which public channels is my bot user in?
-          # - Do I have any direct messages open with my friend Suzy?
-          # - Is my bot a member of any private channels?
+          # List conversations the calling user may access.
           #
           # @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.
@@ -18,6 +15,8 @@ module Slack
           #   Set to true to exclude archived channels from the list.
           # @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 list hasn't been reached. Must be an integer no larger than 1000.
+          # @option options [Object] :team_id
+          #   encoded team id to list conversations in, required if org token is used.
           # @option options [Object] :types
           #   Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.
           # @option options [user] :user
@@ -36,7 +35,7 @@ module Slack
           end
 
           #
-          # 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/slack-ruby/slack-api-ref/blob/master/methods/users/users.deletePhoto.json
@@ -45,21 +44,19 @@ 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 [user] :user
           #   User to get presence info on. Defaults to the authed user.
           # @see https://api.slack.com/methods/users.getPresence
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.getPresence.json
           def users_getPresence(options = {})
-            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('users.getPresence', options)
           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/slack-ruby/slack-api-ref/blob/master/methods/users/users.identity.json
@@ -68,7 +65,7 @@ module Slack
           end
 
           #
-          # This method returns information about a member of a workspace.
+          # Gets information about a user.
           #
           # @option options [user] :user
           #   User to get info on.
@@ -83,14 +80,16 @@ module Slack
           end
 
           #
-          # This method returns a list of all users in the workspace. 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.
+          #   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. Providing no limit value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience limit_required or HTTP 500 errors.
+          # @option options [Object] :team_id
+          #   encoded team id to list users in, required if org token is used.
           # @see https://api.slack.com/methods/users.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.list.json
           def users_list(options = {})
@@ -104,7 +103,7 @@ module Slack
           end
 
           #
-          # Retrieve a single user by looking them up by their registered email address. Requires users:read.email.
+          # Find a user with an email address.
           #
           # @option options [Object] :email
           #   An email address belonging to a user in the workspace.
@@ -116,7 +115,7 @@ module Slack
           end
 
           #
-          # This method is no longer functional and the behavior it controlled is no longer offered. The method will no longer exist beginning May 8, 2018.
+          # Marked a user as active. Deprecated and non-functional.
           #
           # @see https://api.slack.com/methods/users.setActive
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.setActive.json
@@ -125,26 +124,24 @@ 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] :image
+          #   File contents via multipart/form-data.
           # @see https://api.slack.com/methods/users.setPhoto
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.setPhoto.json
           def users_setPhoto(options = {})
-            throw ArgumentError.new('Required arguments :image missing') if options[:image].nil?
             post('users.setPhoto', options)
           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.