slack-ruby-client 0.7.9 → 0.16.0

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminUsersSession
+          #
+          # Revoke a single session for a user. The user will be forced to login to Slack.
+          #
+          # @option options [Object] :session_id
+          #   ID of the session to invalidate.
+          # @option options [Object] :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 [Object] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [Object] :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 [Object] :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
+          #   The ID of the user to wipe sessions for.
+          # @option options [Object] :mobile_only
+          #   Only expire mobile sessions (default: false).
+          # @option options [Object] :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
+          def admin_users_session_reset(options = {})
+            throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
+            post('admin.users.session.reset', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,14 +7,12 @@ module Slack
       module Endpoints
         module Api
           #
-          # This method helps you test your calling code.
+          # Checks API calling code.
           #
           # @option options [Object] :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/dblock/slack-api-ref/blob/master/methods/api/api.test.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/api/api.test.json
           def api_test(options = {})
             post('api.test', options)
           end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Apps
+          #
+          # Uninstalls your app from a workspace.
+          #
+          # @option options [Object] :client_id
+          #   Issued when you created your application.
+          # @option options [Object] :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
+          def apps_uninstall(options = {})
+            throw ArgumentError.new('Required arguments :client_id missing') if options[:client_id].nil?
+            throw ArgumentError.new('Required arguments :client_secret missing') if options[:client_secret].nil?
+            post('apps.uninstall', options)
+          end
+        end
+      end
+    end
+  end
+end

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 [Object] :event_context
+          #   .
+          # @option options [Object] :cursor
+          #   .
+          # @option options [Object] :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_permissions.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsPermissions
+          #
+          # Returns list of permissions this app has on a team.
+          #
+          # @see https://api.slack.com/methods/apps.permissions.info
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions/apps.permissions.info.json
+          def apps_permissions_info(options = {})
+            post('apps.permissions.info', options)
+          end
+
+          #
+          # Allows an app to request additional scopes
+          #
+          # @option options [Object] :scopes
+          #   A comma separated list of scopes to request for.
+          # @option options [Object] :trigger_id
+          #   Token used to trigger the permissions API.
+          # @see https://api.slack.com/methods/apps.permissions.request
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions/apps.permissions.request.json
+          def apps_permissions_request(options = {})
+            throw ArgumentError.new('Required arguments :scopes missing') if options[:scopes].nil?
+            throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
+            post('apps.permissions.request', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsPermissionsResources
+          #
+          # Returns list of resource grants this app has on a 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] :limit
+          #   The maximum number of items to return.
+          # @see https://api.slack.com/methods/apps.permissions.resources.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.resources/apps.permissions.resources.list.json
+          def apps_permissions_resources_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :apps_permissions_resources_list, options).each do |page|
+                yield page
+              end
+            else
+              post('apps.permissions.resources.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/apps_permissions_scopes.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 AppsPermissionsScopes
+          #
+          # Returns list of scopes this app has on a team.
+          #
+          # @see https://api.slack.com/methods/apps.permissions.scopes.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.scopes/apps.permissions.scopes.list.json
+          def apps_permissions_scopes_list(options = {})
+            post('apps.permissions.scopes.list', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsPermissionsUsers
+          #
+          # Returns list of user grants and corresponding scopes this app has on a 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] :limit
+          #   The maximum number of items to return.
+          # @see https://api.slack.com/methods/apps.permissions.users.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.users/apps.permissions.users.list.json
+          def apps_permissions_users_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :apps_permissions_users_list, options).each do |page|
+                yield page
+              end
+            else
+              post('apps.permissions.users.list', options)
+            end
+          end
+
+          #
+          # Enables an app to trigger a permissions modal to grant an app access to a user access scope.
+          #
+          # @option options [Object] :scopes
+          #   A comma separated list of user scopes to request for.
+          # @option options [Object] :trigger_id
+          #   Token used to trigger the request.
+          # @option options [user] :user
+          #   The user this scope is being requested for.
+          # @see https://api.slack.com/methods/apps.permissions.users.request
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.users/apps.permissions.users.request.json
+          def apps_permissions_users_request(options = {})
+            throw ArgumentError.new('Required arguments :scopes missing') if options[:scopes].nil?
+            throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
+            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            post('apps.permissions.users.request', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,21 +7,21 @@ module Slack
       module Endpoints
         module Auth
           #
-          # This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out.
+          # Revokes a token.
           #
           # @option options [Object] :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/dblock/slack-api-ref/blob/master/methods/auth/auth.revoke.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/auth/auth.revoke.json
           def auth_revoke(options = {})
             post('auth.revoke', options)
           end
 
           #
-          # This method checks authentication and tells you who you are.
+          # Checks authentication & identity.
           #
           # @see https://api.slack.com/methods/auth.test
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/auth/auth.test.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/auth/auth.test.json
           def auth_test(options = {})
             post('auth.test', options)
           end

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 [Object] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :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 [Object] :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

@@ -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 Bots
           #
-          # This method returns information about a bot user.
+          # Gets information about a bot user.
           #
           # @option options [Object] :bot
           #   Bot user to get info on.
+          # @option options [Object] :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/dblock/slack-api-ref/blob/master/methods/bots/bots.info.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/bots/bots.info.json
           def bots_info(options = {})
             post('bots.info', options)
           end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Calls
+          #
+          # Registers a new Call.
+          #
+          # @option options [Object] :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
+          #   The URL required for a client to join the Call.
+          # @option options [Object] :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
+          #   Call start time in UTC UNIX timestamp format.
+          # @option options [Object] :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
+          #   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
+          #   The name of the Call.
+          # @option options [Object] :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
+          def calls_add(options = {})
+            throw ArgumentError.new('Required arguments :external_unique_id missing') if options[:external_unique_id].nil?
+            throw ArgumentError.new('Required arguments :join_url missing') if options[:join_url].nil?
+            post('calls.add', options)
+          end
+
+          #
+          # Ends a Call.
+          #
+          # @option options [Object] :id
+          #   id returned when registering the call using the calls.add method.
+          # @option options [Object] :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
+          def calls_end(options = {})
+            throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+            post('calls.end', options)
+          end
+
+          #
+          # Returns information about a Call.
+          #
+          # @option options [Object] :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
+          def calls_info(options = {})
+            throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+            post('calls.info', options)
+          end
+
+          #
+          # Updates information about a Call.
+          #
+          # @option options [Object] :id
+          #   id returned by the calls.add method.
+          # @option options [Object] :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
+          #   The URL required for a client to join the Call.
+          # @option options [Object] :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
+          def calls_update(options = {})
+            throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+            post('calls.update', options)
+          end
+        end
+      end
+    end
+  end
+end