slack-ruby-client 0.15.0 → 1.0.0

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

@@ -13,11 +13,11 @@ module Slack
           #   The ID (T1234) of the workspace.
           # @option options [Object] :user_id
           #   The ID of the user to add to the workspace.
-          # @option options [Object] :channel_ids
+          # @option options [string] :channel_ids
           #   Comma separated values of channel IDs to add user in the new workspace.
-          # @option options [Object] :is_restricted
+          # @option options [boolean] :is_restricted
           #   True if user should be added to the workspace as a guest.
-          # @option options [Object] :is_ultra_restricted
+          # @option options [boolean] :is_ultra_restricted
           #   True if user should be added to the workspace as a single-channel guest.
           # @see https://api.slack.com/methods/admin.users.assign
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.assign.json
@@ -30,23 +30,25 @@ module Slack
           #
           # Invite a user to a workspace.
           #
-          # @option options [Object] :channel_ids
+          # @option options [string] :channel_ids
           #   A comma-separated list of channel_ids for this user to join. At least one channel is required.
-          # @option options [Object] :email
+          # @option options [string] :email
           #   The email address of the person to invite.
           # @option options [Object] :team_id
           #   The ID (T1234) of the workspace.
-          # @option options [Object] :custom_message
+          # @option options [string] :custom_message
           #   An optional message to send to the user in the invite email.
-          # @option options [Object] :guest_expiration_ts
+          # @option options [boolean] :email_password_policy_enabled
+          #   Allow invited user to sign in via email and password. Only available for Enterprise Grid teams via admin invite.
+          # @option options [string] :guest_expiration_ts
           #   Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.
-          # @option options [Object] :is_restricted
+          # @option options [boolean] :is_restricted
           #   Is this user a multi-channel guest user? (default: false).
-          # @option options [Object] :is_ultra_restricted
+          # @option options [boolean] :is_ultra_restricted
           #   Is this user a single channel guest user? (default: false).
-          # @option options [Object] :real_name
+          # @option options [string] :real_name
           #   Full name of the user.
-          # @option options [Object] :resend
+          # @option options [boolean] :resend
           #   Allow this invite to be resent in the future if a user has not signed up yet. (default: false).
           # @see https://api.slack.com/methods/admin.users.invite
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.invite.json
@@ -60,16 +62,15 @@ module Slack
           #
           # List users on a workspace
           #
-          # @option options [Object] :team_id
-          #   The ID (T1234) of the workspace.
-          # @option options [Object] :cursor
+          # @option options [string] :cursor
           #   Set cursor to next_cursor returned by the previous call to list items in the next page.
-          # @option options [Object] :limit
+          # @option options [integer] :limit
           #   Limit for how many users to be retrieved per page.
+          # @option options [Object] :team_id
+          #   The ID (T1234) of the workspace.
           # @see https://api.slack.com/methods/admin.users.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.list.json
           def admin_users_list(options = {})
-            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
             if block_given?
               Pagination::Cursor.new(self, :admin_users_list, options).each do |page|
                 yield page
@@ -84,7 +85,7 @@ module Slack
           #
           # @option options [Object] :team_id
           #   The ID (T1234) of the workspace.
-          # @option options [Object] :user_id
+          # @option options [string] :user_id
           #   The ID of the user to remove.
           # @see https://api.slack.com/methods/admin.users.remove
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.remove.json
@@ -99,7 +100,7 @@ module Slack
           #
           # @option options [Object] :team_id
           #   The ID (T1234) of the workspace.
-          # @option options [Object] :user_id
+          # @option options [string] :user_id
           #   The ID of the user to designate as an admin.
           # @see https://api.slack.com/methods/admin.users.setAdmin
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setAdmin.json
@@ -112,17 +113,16 @@ module Slack
           #
           # Set an expiration for a guest user
           #
-          # @option options [Object] :expiration_ts
+          # @option options [integer] :expiration_ts
           #   Timestamp when guest account should be disabled.
+          # @option options [string] :user_id
+          #   The ID of the user to set an expiration for.
           # @option options [Object] :team_id
           #   The ID (T1234) of the workspace.
-          # @option options [Object] :user_id
-          #   The ID of the user to set an expiration for.
           # @see https://api.slack.com/methods/admin.users.setExpiration
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setExpiration.json
           def admin_users_setExpiration(options = {})
             throw ArgumentError.new('Required arguments :expiration_ts missing') if options[:expiration_ts].nil?
-            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
             throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
             post('admin.users.setExpiration', options)
           end
@@ -147,7 +147,7 @@ module Slack
           #
           # @option options [Object] :team_id
           #   The ID (T1234) of the workspace.
-          # @option options [Object] :user_id
+          # @option options [string] :user_id
           #   The ID of the user to designate as a regular user.
           # @see https://api.slack.com/methods/admin.users.setRegular
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setRegular.json

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

@@ -6,14 +6,76 @@ module Slack
     module Api
       module Endpoints
         module AdminUsersSession
+          #
+          # Clear user-specific session settings—the session duration and what happens when the client closes—for a list of users.
+          #
+          # @option options [array] :user_ids
+          #   The IDs of users you'd like to clear session settings for.
+          # @see https://api.slack.com/methods/admin.users.session.clearSettings
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.session/admin.users.session.clearSettings.json
+          def admin_users_session_clearSettings(options = {})
+            throw ArgumentError.new('Required arguments :user_ids missing') if options[:user_ids].nil?
+            post('admin.users.session.clearSettings', options)
+          end
+
+          #
+          # Get user-specific session settings—the session duration and what happens when the client closes—given a list of users.
+          #
+          # @option options [array] :user_ids
+          #   The IDs of users you'd like to fetch session settings for. Note: if a user does not have any active sessions, they will not be returned in the response.
+          # @see https://api.slack.com/methods/admin.users.session.getSettings
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.session/admin.users.session.getSettings.json
+          def admin_users_session_getSettings(options = {})
+            throw ArgumentError.new('Required arguments :user_ids missing') if options[:user_ids].nil?
+            post('admin.users.session.getSettings', options)
+          end
+
+          #
+          # Revoke a single session for a user. The user will be forced to login to Slack.
+          #
+          # @option options [integer] :session_id
+          #   ID of the session to invalidate.
+          # @option options [string] :team_id
+          #   ID of the workspace that the session belongs to.
+          # @see https://api.slack.com/methods/admin.users.session.invalidate
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.session/admin.users.session.invalidate.json
+          def admin_users_session_invalidate(options = {})
+            throw ArgumentError.new('Required arguments :session_id missing') if options[:session_id].nil?
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            post('admin.users.session.invalidate', options)
+          end
+
+          #
+          # List active user sessions for an organization
+          #
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [integer] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [string] :team_id
+          #   The ID of the workspace you'd like active sessions for. If you pass a team_id, you'll need to pass a user_id as well.
+          # @option options [string] :user_id
+          #   The ID of user you'd like active sessions for. If you pass a user_id, you'll need to pass a team_id as well.
+          # @see https://api.slack.com/methods/admin.users.session.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.session/admin.users.session.list.json
+          def admin_users_session_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_users_session_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.users.session.list', options)
+            end
+          end
+
           #
           # Wipes all valid sessions on all devices for a given user
           #
-          # @option options [Object] :user_id
+          # @option options [string] :user_id
           #   The ID of the user to wipe sessions for.
-          # @option options [Object] :mobile_only
+          # @option options [boolean] :mobile_only
           #   Only expire mobile sessions (default: false).
-          # @option options [Object] :web_only
+          # @option options [boolean] :web_only
           #   Only expire web sessions (default: false).
           # @see https://api.slack.com/methods/admin.users.session.reset
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.session/admin.users.session.reset.json
@@ -21,6 +83,38 @@ module Slack
             throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
             post('admin.users.session.reset', options)
           end
+
+          #
+          # Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users
+          #
+          # @option options [array] :user_ids
+          #   The ID of the user to wipe sessions for.
+          # @option options [boolean] :mobile_only
+          #   Only expire mobile sessions (default: false).
+          # @option options [boolean] :web_only
+          #   Only expire web sessions (default: false).
+          # @see https://api.slack.com/methods/admin.users.session.resetBulk
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.session/admin.users.session.resetBulk.json
+          def admin_users_session_resetBulk(options = {})
+            throw ArgumentError.new('Required arguments :user_ids missing') if options[:user_ids].nil?
+            post('admin.users.session.resetBulk', options)
+          end
+
+          #
+          # Configure the user-level session settings—the session duration and what happens when the client closes—for one or more users.
+          #
+          # @option options [array] :user_ids
+          #   The list of user IDs to apply the session settings for.
+          # @option options [boolean] :desktop_app_browser_quit
+          #   Terminate the session when the client—either the desktop app or a browser window—is closed.
+          # @option options [integer] :duration
+          #   The session duration, in seconds. The minimum value is 28800, which represents 8 hours; the max value is 315569520 or 10 years (that's a long Slack session).
+          # @see https://api.slack.com/methods/admin.users.session.setSettings
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.session/admin.users.session.setSettings.json
+          def admin_users_session_setSettings(options = {})
+            throw ArgumentError.new('Required arguments :user_ids missing') if options[:user_ids].nil?
+            post('admin.users.session.setSettings', options)
+          end
         end
       end
     end

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

@@ -9,10 +9,8 @@ module Slack
           #
           # Checks API calling code.
           #
-          # @option options [Object] :error
+          # @option options [string] :error
           #   Error response to return.
-          # @option options [Object] :foo
-          #   example property to return.
           # @see https://api.slack.com/methods/api.test
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/api/api.test.json
           def api_test(options = {})

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

@@ -9,9 +9,9 @@ module Slack
           #
           # Uninstalls your app from a workspace.
           #
-          # @option options [Object] :client_id
+          # @option options [string] :client_id
           #   Issued when you created your application.
-          # @option options [Object] :client_secret
+          # @option options [string] :client_secret
           #   Issued when you created your application.
           # @see https://api.slack.com/methods/apps.uninstall
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps/apps.uninstall.json

data/lib/slack/web/api/endpoints/apps_connections.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 AppsConnections
+          #
+          # Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over,
+          #
+          # @see https://api.slack.com/methods/apps.connections.open
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.connections/apps.connections.open.json
+          def apps_connections_open(options = {})
+            post('apps.connections.open', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsEventAuthorizations
+          #
+          # Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.
+          #
+          # @option options [string] :event_context
+          #   .
+          # @option options [string] :cursor
+          #   .
+          # @option options [integer] :limit
+          #   .
+          # @see https://api.slack.com/methods/apps.event.authorizations.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.event.authorizations/apps.event.authorizations.list.json
+          def apps_event_authorizations_list(options = {})
+            throw ArgumentError.new('Required arguments :event_context missing') if options[:event_context].nil?
+            if block_given?
+              Pagination::Cursor.new(self, :apps_event_authorizations_list, options).each do |page|
+                yield page
+              end
+            else
+              post('apps.event.authorizations.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsManifest
+          #
+          # Create an app from an app manifest.
+          #
+          # @option options [manifest object as string] :manifest
+          #   A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one.
+          # @see https://api.slack.com/methods/apps.manifest.create
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.manifest/apps.manifest.create.json
+          def apps_manifest_create(options = {})
+            throw ArgumentError.new('Required arguments :manifest missing') if options[:manifest].nil?
+            post('apps.manifest.create', options)
+          end
+
+          #
+          # Permanently deletes an app created through app manifests
+          #
+          # @option options [Object] :app_id
+          #   The ID of the app you want to delete.
+          # @see https://api.slack.com/methods/apps.manifest.delete
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.manifest/apps.manifest.delete.json
+          def apps_manifest_delete(options = {})
+            throw ArgumentError.new('Required arguments :app_id missing') if options[:app_id].nil?
+            post('apps.manifest.delete', options)
+          end
+
+          #
+          # Export an app manifest from an existing app
+          #
+          # @option options [Object] :app_id
+          #   The ID of the app whose configuration you want to export as a manifest.
+          # @see https://api.slack.com/methods/apps.manifest.export
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.manifest/apps.manifest.export.json
+          def apps_manifest_export(options = {})
+            throw ArgumentError.new('Required arguments :app_id missing') if options[:app_id].nil?
+            post('apps.manifest.export', options)
+          end
+
+          #
+          # Update an app from an app manifest
+          #
+          # @option options [Object] :app_id
+          #   The ID of the app whose configuration you want to update.
+          # @option options [manifest object as string] :manifest
+          #   A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one. As this method entirely replaces any previous configuration, manifest must contain both unmodified and modified fields.
+          # @see https://api.slack.com/methods/apps.manifest.update
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.manifest/apps.manifest.update.json
+          def apps_manifest_update(options = {})
+            throw ArgumentError.new('Required arguments :app_id missing') if options[:app_id].nil?
+            throw ArgumentError.new('Required arguments :manifest missing') if options[:manifest].nil?
+            post('apps.manifest.update', options)
+          end
+
+          #
+          # Validate an app manifest
+          #
+          # @option options [manifest object as string] :manifest
+          #   The manifest to be validated. Will be validated against the app manifest schema - read our guide.
+          # @see https://api.slack.com/methods/apps.manifest.validate
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.manifest/apps.manifest.validate.json
+          def apps_manifest_validate(options = {})
+            throw ArgumentError.new('Required arguments :manifest missing') if options[:manifest].nil?
+            post('apps.manifest.validate', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -9,7 +9,7 @@ module Slack
           #
           # Revokes a token.
           #
-          # @option options [Object] :test
+          # @option options [boolean] :test
           #   Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.
           # @see https://api.slack.com/methods/auth.revoke
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/auth/auth.revoke.json

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AuthTeams
+          #
+          # List the workspaces a token can access.
+          #
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [boolean] :include_icon
+          #   Whether to return icon paths for each workspace. An icon path represents a URI pointing to the image signifying the workspace.
+          # @option options [integer] :limit
+          #   The maximum number of workspaces to return. Must be a positive integer no larger than 1000.
+          # @see https://api.slack.com/methods/auth.teams.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/auth.teams/auth.teams.list.json
+          def auth_teams_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :auth_teams_list, options).each do |page|
+                yield page
+              end
+            else
+              post('auth.teams.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -9,8 +9,10 @@ module Slack
           #
           # Gets information about a bot user.
           #
-          # @option options [Object] :bot
+          # @option options [user] :bot
           #   Bot user to get info on.
+          # @option options [team] :team_id
+          #   encoded team id or enterprise id where the bot exists, required if org token is used.
           # @see https://api.slack.com/methods/bots.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/bots/bots.info.json
           def bots_info(options = {})

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

@@ -9,21 +9,21 @@ module Slack
           #
           # Registers a new Call.
           #
-          # @option options [Object] :external_unique_id
+          # @option options [string] :external_unique_id
           #   An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.
-          # @option options [Object] :join_url
+          # @option options [string] :join_url
           #   The URL required for a client to join the Call.
-          # @option options [Object] :created_by
+          # @option options [string] :created_by
           #   The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required.
-          # @option options [Object] :date_start
+          # @option options [integer] :date_start
           #   Call start time in UTC UNIX timestamp format.
-          # @option options [Object] :desktop_app_join_url
+          # @option options [string] :desktop_app_join_url
           #   When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
-          # @option options [Object] :external_display_id
+          # @option options [string] :external_display_id
           #   An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.
-          # @option options [Object] :title
+          # @option options [string] :title
           #   The name of the Call.
-          # @option options [Object] :users
+          # @option options [array] :users
           #   The list of users to register as participants in the Call. Read more on how to specify users here.
           # @see https://api.slack.com/methods/calls.add
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.add.json
@@ -36,9 +36,9 @@ module Slack
           #
           # Ends a Call.
           #
-          # @option options [Object] :id
+          # @option options [string] :id
           #   id returned when registering the call using the calls.add method.
-          # @option options [Object] :duration
+          # @option options [integer] :duration
           #   Call duration in seconds.
           # @see https://api.slack.com/methods/calls.end
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.end.json
@@ -50,7 +50,7 @@ module Slack
           #
           # Returns information about a Call.
           #
-          # @option options [Object] :id
+          # @option options [string] :id
           #   id of the Call returned by the calls.add method.
           # @see https://api.slack.com/methods/calls.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.info.json
@@ -62,13 +62,13 @@ module Slack
           #
           # Updates information about a Call.
           #
-          # @option options [Object] :id
+          # @option options [string] :id
           #   id returned by the calls.add method.
-          # @option options [Object] :desktop_app_join_url
+          # @option options [string] :desktop_app_join_url
           #   When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
-          # @option options [Object] :join_url
+          # @option options [string] :join_url
           #   The URL required for a client to join the Call.
-          # @option options [Object] :title
+          # @option options [string] :title
           #   The name of the Call.
           # @see https://api.slack.com/methods/calls.update
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.update.json

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

@@ -9,9 +9,9 @@ module Slack
           #
           # Registers new participants added to a Call.
           #
-          # @option options [Object] :id
+          # @option options [string] :id
           #   id returned by the calls.add method.
-          # @option options [Object] :users
+          # @option options [array] :users
           #   The list of users to add as participants in the Call. Read more on how to specify users here.
           # @see https://api.slack.com/methods/calls.participants.add
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls.participants/calls.participants.add.json
@@ -24,9 +24,9 @@ module Slack
           #
           # Registers participants removed from a Call.
           #
-          # @option options [Object] :id
+          # @option options [string] :id
           #   id returned by the calls.add method.
-          # @option options [Object] :users
+          # @option options [array] :users
           #   The list of users to remove as participants in the Call. Read more on how to specify users here.
           # @see https://api.slack.com/methods/calls.participants.remove
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls.participants/calls.participants.remove.json