slack-ruby-client 0.7.9 → 0.16.0

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,12 +7,12 @@ 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.
           # @see https://api.slack.com/methods/team.profile.get
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/team.profile/team.profile.get.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/team.profile/team.profile.get.json
           def team_profile_get(options = {})
             post('team.profile.get', options)
           end

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,85 +7,95 @@ 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.
-          # @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.
+          # @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/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.create.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.create.json
           def usergroups_create(options = {})
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
             post('usergroups.create', options)
           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/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.disable.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.disable.json
           def usergroups_disable(options = {})
             throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
             post('usergroups.disable', options)
           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/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.enable.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.enable.json
           def usergroups_enable(options = {})
             throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
             post('usergroups.enable', options)
           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.
+          # @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/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.list.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.list.json
           def usergroups_list(options = {})
             post('usergroups.list', options)
           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.
+          # @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/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.update.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.update.json
           def usergroups_update(options = {})
             throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
             post('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,21 +7,23 @@ 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/dblock/slack-api-ref/blob/master/methods/usergroups.users/usergroups.users.list.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups.users/usergroups.users.list.json
           def usergroups_users_list(options = {})
             throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
             post('usergroups.users.list', options)
           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,8 +31,10 @@ 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/dblock/slack-api-ref/blob/master/methods/usergroups.users/usergroups.users.update.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups.users/usergroups.users.update.json
           def usergroups_users_update(options = {})
             throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
             throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?

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,44 +7,72 @@ module Slack
       module Endpoints
         module Users
           #
-          # This method allows the user to delete their profile image. It will clear whatever image is currently set.
+          # 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.
+          # @option options [Object] :exclude_archived
+          #   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
+          #   Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.
+          # @see https://api.slack.com/methods/users.conversations
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.conversations.json
+          def users_conversations(options = {})
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            if block_given?
+              Pagination::Cursor.new(self, :users_conversations, options).each do |page|
+                yield page
+              end
+            else
+              post('users.conversations', options)
+            end
+          end
+
+          #
+          # Delete the user profile photo
           #
           # @see https://api.slack.com/methods/users.deletePhoto
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users/users.deletePhoto.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.deletePhoto.json
           def users_deletePhoto(options = {})
             post('users.deletePhoto', options)
           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/dblock/slack-api-ref/blob/master/methods/users/users.getPresence.json
+          # @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/dblock/slack-api-ref/blob/master/methods/users/users.identity.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.identity.json
           def users_identity(options = {})
             post('users.identity', options)
           end
 
           #
-          # This method returns information about a team member.
+          # Gets information about a user.
           #
           # @option options [user] :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/dblock/slack-api-ref/blob/master/methods/users/users.info.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.info.json
           def users_info(options = {})
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
@@ -51,53 +80,73 @@ 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] :presence
-          #   Whether to include presence data in the output.
+          # @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. 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/dblock/slack-api-ref/blob/master/methods/users/users.list.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.list.json
           def users_list(options = {})
-            post('users.list', options)
+            if block_given?
+              Pagination::Cursor.new(self, :users_list, options).each do |page|
+                yield page
+              end
+            else
+              post('users.list', options)
+            end
           end
 
           #
-          # This method lets the slack messaging server know that the authenticated user
-          # is currently active. Consult the presence documentation for
-          # more details.
+          # 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/slack-ruby/slack-api-ref/blob/master/methods/users/users.lookupByEmail.json
+          def users_lookupByEmail(options = {})
+            throw ArgumentError.new('Required arguments :email missing') if options[:email].nil?
+            post('users.lookupByEmail', options)
+          end
+
+          #
+          # Marked a user as active. Deprecated and non-functional.
           #
           # @see https://api.slack.com/methods/users.setActive
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users/users.setActive.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.setActive.json
           def users_setActive(options = {})
             post('users.setActive', options)
           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).
+          # @option options [Object] :image
+          #   File contents via multipart/form-data.
           # @see https://api.slack.com/methods/users.setPhoto
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users/users.setPhoto.json
+          # @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.
           # @see https://api.slack.com/methods/users.setPresence
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users/users.setPresence.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.setPresence.json
           def users_setPresence(options = {})
             throw ArgumentError.new('Required arguments :presence missing') if options[:presence].nil?
             post('users.setPresence', options)

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module UsersAdmin
+          #
+          # Send an invitation to a new user by email (undocumented)
+          #
+          # @option options [Object] :email
+          #   Email address of the new user
+          # @option options [Object] :channels
+          #   Comma-separated list of IDs (not names!) for channels, which the new user will auto-join. Both channel IDs for public channels and group IDs for private chanels work.
+          # @option options [Object] :first_name
+          #   Prefilled input for the "First name" field on the "new user registration" page.
+          # @option options [Object] :last_name
+          #   Prefilled input for the "Last name" field on the "new user registration" page.
+          # @option options [Object] :resend
+          #   Resend the invitation email if the user has already been invited and the email was sent some time ago.
+          # @option options [Object] :restricted
+          #   Invite a guest that can use multiple channels
+          # @option options [Object] :ultra_restricted
+          #   Invite a guest that can use one channel only
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/undocumented/users.admin/users.admin.invite.json
+          def users_admin_invite(options = {})
+            throw ArgumentError.new('Required arguments :email missing') if options[:email].nil?
+            logger.warn('The users.admin.invite method is undocumented.')
+            post('users.admin.invite', options)
+          end
+
+          #
+          # Disable a user (undocumented)
+          #
+          # @option options [user] :user
+          #   User to disable
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/undocumented/users.admin/users.admin.setInactive.json
+          def users_admin_setInactive(options = {})
+            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            logger.warn('The users.admin.setInactive method is undocumented.')
+            post('users.admin.setInactive', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module UsersPrefs
+          #
+          # Returns the user's preferences (undocumented)
+          #
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/undocumented/users.prefs/users.prefs.get.json
+          def users_prefs_get(options = {})
+            logger.warn('The users.prefs.get method is undocumented.')
+            post('users.prefs.get', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,32 +7,32 @@ module Slack
       module Endpoints
         module UsersProfile
           #
-          # This method is used to get the profile information for a user.
+          # Retrieve a user's profile information, including their custom status.
           #
+          # @option options [Object] :include_labels
+          #   Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended.
           # @option options [user] :user
           #   User to retrieve profile info for.
-          # @option options [Object] :include_labels
-          #   Include labels for each ID in custom profile fields.
           # @see https://api.slack.com/methods/users.profile.get
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users.profile/users.profile.get.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users.profile/users.profile.get.json
           def users_profile_get(options = {})
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('users.profile.get', options)
           end
 
           #
-          # This method is used to set the profile information for a user.
+          # Set a user's profile information, including custom status.
           #
-          # @option options [user] :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. At most 50 fields may be set. Each field name is limited to 255 characters.
+          # @option options [user] :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
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users.profile/users.profile.set.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users.profile/users.profile.set.json
           def users_profile_set(options = {})
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('users.profile.set', options)