slack-ruby-client 2.1.0 → 2.2.0

data/lib/slack/real_time/concurrency/async.rb

@@ -67,6 +67,10 @@ module Slack
             @restart&.signal
           end
 
+          def run_async(&block)
+            ::Async.run(&block)
+          end
+
           def current_time
             ::Async::Clock.now
           end

data/lib/slack/real_time/config.rb

@@ -3,6 +3,7 @@ module Slack
   module RealTime
     module Config
       class NoConcurrencyError < StandardError; end
+      class InvalidAsyncHandlersError < StandardError; end
 
       extend self
 
@@ -15,6 +16,7 @@ module Slack
         store_class
         store_options
         logger
+        async_handlers
       ].freeze
 
       attr_accessor(*Config::ATTRIBUTES - [:concurrency])
@@ -29,6 +31,7 @@ module Slack
         self.store_class = Slack::RealTime::Stores::Starter
         self.store_options = {}
         self.logger = nil
+        self.async_handlers = :none
       end
 
       def concurrency

data/lib/slack/real_time/socket.rb

@@ -63,6 +63,10 @@ module Slack
         raise NotImplementedError, "Expected #{self.class} to implement #{__method__}."
       end
 
+      def run_async(&_block)
+        raise NotImplementedError, "Expected #{self.class} to implement #{__method__}."
+      end
+
       def time_since_last_message
         return 0 unless @last_message_at
 

data/lib/slack/real_time/stores/starter.rb

@@ -309,12 +309,12 @@ module Slack
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/shared_channel_invite_received.json
         # on :shared_channel_invite_received do |data|
 
-        # A member has starred an item.
+        # A member has saved an item for later or starred an item.
         # @see https://api.slack.com/events/star_added
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/star_added.json
         # on :star_added do |data|
 
-        # A member removed a star.
+        # A member has removed an item saved for later or starred an item.
         # @see https://api.slack.com/events/star_removed
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/star_removed.json
         # on :star_removed do |data|

data/lib/slack/real_time/stores/store.rb

@@ -495,12 +495,12 @@ module Slack
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/shared_channel_invite_received.json
         # on :shared_channel_invite_received do |data|
 
-        # A member has starred an item.
+        # A member has saved an item for later or starred an item.
         # @see https://api.slack.com/events/star_added
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/star_added.json
         # on :star_added do |data|
 
-        # A member removed a star.
+        # A member has removed an item saved for later or starred an item.
         # @see https://api.slack.com/events/star_removed
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/star_removed.json
         # on :star_removed do |data|

data/lib/slack/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Slack
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAppsActivities
+          #
+          # Get logs for a specified team/org
+          #
+          # @option options [Object] :app_id
+          #   The ID of the app to get activities from.
+          # @option options [string] :component_id
+          #   The component ID of log events to be returned. Will be 'FnXXXXXX' for functions, and 'WfXXXXXX' for worflows.
+          # @option options [string] :component_type
+          #   The component type of log events to be returned. Acceptable values are ('events_api', 'workflows', 'functions', 'tables').
+          # @option options [string] :cursor
+          #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. See pagination for more detail.
+          # @option options [integer] :limit
+          #   The maximum number of items to return.
+          # @option options [string] :log_event_type
+          #   The event type of log events to be returned.
+          # @option options [integer] :max_date_created
+          #   The latest timestamp of the log to retrieve (epoch microseconds).
+          # @option options [integer] :min_date_created
+          #   The earliest timestamp of the log to retrieve (epoch microseconds).
+          # @option options [string] :min_log_level
+          #   The minimum log level of the log events to be returned. Defaults to 'info'. Acceptable values (in order of relative importance from smallest to largest) are ('trace', 'debug', 'info', 'warn', 'error', 'fatal').
+          # @option options [string] :sort_direction
+          #   The direction you want the data sorted by (always by timestamp).
+          # @option options [string] :source
+          #   The source of log events to be returned. Acceptable values are ('slack', 'developer').
+          # @option options [string] :team_id
+          #   The team who owns this log.
+          # @option options [string] :trace_id
+          #   The trace ID of log events to be returned.
+          # @see https://api.slack.com/methods/admin.apps.activities.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.activities/admin.apps.activities.list.json
+          def admin_apps_activities_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_apps_activities_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.apps.activities.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -9,6 +9,8 @@ module Slack
           #
           # List approved apps for an org or workspace.
           #
+          # @option options [boolean] :certified
+          #   Limit the results to only include certified apps. When false, no certified apps will appear in the result.
           # @option options [string] :cursor
           #   Set cursor to next_cursor returned by the previous call to list items in the next page.
           # @option options [Object] :enterprise_id

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAppsConfig
+          #
+          # Look up the app config for connectors by their IDs
+          #
+          # @option options [array] :app_ids
+          #   An array of app IDs to get app configs for.
+          # @see https://api.slack.com/methods/admin.apps.config.lookup
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.config/admin.apps.config.lookup.json
+          def admin_apps_config_lookup(options = {})
+            raise ArgumentError, 'Required arguments :app_ids missing' if options[:app_ids].nil?
+            post('admin.apps.config.lookup', options)
+          end
+
+          #
+          # Set the app config for a connector
+          #
+          # @option options [Object] :app_id
+          #   The encoded app ID to set the app config for.
+          # @option options [object] :domain_restrictions
+          #   Domain restrictions for the app.
+          # @option options [string] :workflow_auth_strategy
+          #   The workflow auth permission.
+          # @see https://api.slack.com/methods/admin.apps.config.set
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.config/admin.apps.config.set.json
+          def admin_apps_config_set(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            post('admin.apps.config.set', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -25,6 +25,8 @@ module Slack
           #
           # List app requests for a team/workspace.
           #
+          # @option options [boolean] :certified
+          #   Include requests for certified apps.
           # @option options [string] :cursor
           #   Set cursor to next_cursor returned by the previous call to list items in the next page.
           # @option options [Object] :enterprise_id

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

@@ -9,6 +9,8 @@ module Slack
           #
           # List restricted apps for an org or workspace.
           #
+          # @option options [boolean] :certified
+          #   Limit the results to only include certified apps. When false, no certified apps will appear in the result.
           # @option options [string] :cursor
           #   Set cursor to next_cursor returned by the previous call to list items in the next page.
           # @option options [Object] :enterprise_id

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

@@ -288,6 +288,7 @@ module Slack
           def admin_conversations_setConversationPrefs(options = {})
             raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
             raise ArgumentError, 'Required arguments :prefs missing' if options[:prefs].nil?
+            options = encode_options_as_json(options, %i[prefs])
             post('admin.conversations.setConversationPrefs', options)
           end
 

data/lib/slack/web/api/endpoints/admin_functions.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 AdminFunctions
+          #
+          # Look up functions by a set of apps
+          #
+          # @option options [array] :app_ids
+          #   Comma-separated array of app IDs to get functions for; max 50.
+          # @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 number of results that will be returned by the API on each invocation. Must be between 1 and 1000, both inclusive.
+          # @option options [Object] :team_id
+          #   The team context to retrieve functions from.
+          # @see https://api.slack.com/methods/admin.functions.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.functions/admin.functions.list.json
+          def admin_functions_list(options = {})
+            raise ArgumentError, 'Required arguments :app_ids missing' if options[:app_ids].nil?
+            if block_given?
+              Pagination::Cursor.new(self, :admin_functions_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.functions.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminFunctionsPermissions
+          #
+          # Lookup the visibility of multiple Slack functions and include the users if it is limited to particular named entities.
+          #
+          # @option options [array] :function_ids
+          #   An array of function IDs to get permissions for.
+          # @see https://api.slack.com/methods/admin.functions.permissions.lookup
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.functions.permissions/admin.functions.permissions.lookup.json
+          def admin_functions_permissions_lookup(options = {})
+            raise ArgumentError, 'Required arguments :function_ids missing' if options[:function_ids].nil?
+            post('admin.functions.permissions.lookup', options)
+          end
+
+          #
+          # Set the visibility of a Slack function and define the users or workspaces if it is set to named_entities
+          #
+          # @option options [string] :function_id
+          #   The function ID to set permissions for.
+          # @option options [string] :visibility
+          #   The function visibility.
+          # @option options [array] :user_ids
+          #   List of user IDs to allow for named_entities visibility.
+          # @see https://api.slack.com/methods/admin.functions.permissions.set
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.functions.permissions/admin.functions.permissions.set.json
+          def admin_functions_permissions_set(options = {})
+            raise ArgumentError, 'Required arguments :function_id missing' if options[:function_id].nil?
+            raise ArgumentError, 'Required arguments :visibility missing' if options[:visibility].nil?
+            post('admin.functions.permissions.set', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -32,7 +32,7 @@ module Slack
           # @option options [array] :entity_ids
           #   The entities for which the roles apply.
           # @option options [integer] :limit
-          #   The maximum number of items to return. Must be between 1 - 100 both inclusive.
+          #   The maximum number of items to return. Must be between 1 - 200 both inclusive.
           # @option options [array] :role_ids
           #   collection of role ids to scope results by.
           # @option options [string] :sort_dir

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

@@ -31,7 +31,7 @@ module Slack
           # @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 - 100 both inclusive.
+          #   The maximum number of items to return. Must be a positive integer no larger than 1000.
           # @see https://api.slack.com/methods/admin.teams.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams/admin.teams.list.json
           def admin_teams_list(options = {})

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

@@ -49,7 +49,7 @@ module Slack
           # @option options [string] :real_name
           #   Full name of the user.
           # @option options [boolean] :resend
-          #   Allow this invite to be resent in the future if a user has not signed up yet. (default: false).
+          #   Allow this invite to be resent in the future if a user has not signed up yet. Resending can only be done via the UI and has no expiration. (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
           def admin_users_invite(options = {})
@@ -114,7 +114,7 @@ module Slack
           # Set an expiration for a guest user
           #
           # @option options [integer] :expiration_ts
-          #   Timestamp when guest account should be disabled.
+          #   Epoch timestamp in seconds 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

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminWorkflows
+          #
+          # Search workflows within the team or enterprise
+          #
+          # @option options [Object] :app_id
+          #   The parent app ID for which to return workflows.
+          # @option options [array] :collaborator_ids
+          #   Only include workflows by the collaborators inputted.
+          # @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 number of results that will be returned by the API on each invocation.
+          # @option options [boolean] :no_collaborators
+          #   Only include workflows with no collaborators in the result; default is false.
+          # @option options [integer] :num_trigger_ids
+          #   Number of trigger IDs to fetch for each workflow; default is 0.
+          # @option options [string] :query
+          #   A search query to filter for workflow name or description.
+          # @option options [string] :sort
+          #   The field used to sort the returned workflows.
+          # @option options [string] :sort_dir
+          #   Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a).
+          # @option options [string] :source
+          #   Source of workflow creation, either from code or workflow builder.
+          # @see https://api.slack.com/methods/admin.workflows.search
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.workflows/admin.workflows.search.json
+          def admin_workflows_search(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_workflows_search, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.workflows.search', options)
+            end
+          end
+
+          #
+          # Unpublish workflows within the team or enterprise
+          #
+          # @option options [array] :workflow_ids
+          #   Array of workflow IDs to unpublish.
+          # @see https://api.slack.com/methods/admin.workflows.unpublish
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.workflows/admin.workflows.unpublish.json
+          def admin_workflows_unpublish(options = {})
+            raise ArgumentError, 'Required arguments :workflow_ids missing' if options[:workflow_ids].nil?
+            post('admin.workflows.unpublish', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminWorkflowsCollaborators
+          #
+          # Add collaborators to workflows within the team or enterprise
+          #
+          # @option options [array] :collaborator_ids
+          #   Array of collaborators (encoded user IDs) to add; max 50.
+          # @option options [array] :workflow_ids
+          #   Array of workflow IDs to edit; max 50.
+          # @see https://api.slack.com/methods/admin.workflows.collaborators.add
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.workflows.collaborators/admin.workflows.collaborators.add.json
+          def admin_workflows_collaborators_add(options = {})
+            raise ArgumentError, 'Required arguments :collaborator_ids missing' if options[:collaborator_ids].nil?
+            raise ArgumentError, 'Required arguments :workflow_ids missing' if options[:workflow_ids].nil?
+            post('admin.workflows.collaborators.add', options)
+          end
+
+          #
+          # Remove collaborators from workflows within the team or enterprise
+          #
+          # @option options [array] :collaborator_ids
+          #   Array of collaborators (encoded user IDs) to remove; max 50.
+          # @option options [array] :workflow_ids
+          #   Array of workflow IDs to edit; max 50.
+          # @see https://api.slack.com/methods/admin.workflows.collaborators.remove
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.workflows.collaborators/admin.workflows.collaborators.remove.json
+          def admin_workflows_collaborators_remove(options = {})
+            raise ArgumentError, 'Required arguments :collaborator_ids missing' if options[:collaborator_ids].nil?
+            raise ArgumentError, 'Required arguments :workflow_ids missing' if options[:workflow_ids].nil?
+            post('admin.workflows.collaborators.remove', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminWorkflowsPermissions
+          #
+          # Look up the permissions for a set of workflows
+          #
+          # @option options [array] :workflow_ids
+          #   An array of workflow IDs to look up permissions for.
+          # @option options [integer] :max_workflow_triggers
+          #   Maximum number of triggers to fetch for each workflow when determining overall run permissions; max 1000.
+          # @see https://api.slack.com/methods/admin.workflows.permissions.lookup
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.workflows.permissions/admin.workflows.permissions.lookup.json
+          def admin_workflows_permissions_lookup(options = {})
+            raise ArgumentError, 'Required arguments :workflow_ids missing' if options[:workflow_ids].nil?
+            post('admin.workflows.permissions.lookup', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsActivities
+          #
+          # Get logs for a specified app
+          #
+          # @option options [Object] :app_id
+          #   The id of the app to get activities from.
+          # @option options [string] :component_id
+          #   The component id of log events to be returned. Will be 'FnXXXXXX' for functions, and 'WfXXXXXX' for worflows.
+          # @option options [string] :component_type
+          #   The component type of log events to be returned. Acceptable values are ('events_api', 'workflows', 'functions', 'tables').
+          # @option options [string] :cursor
+          #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. See pagination for more detail.
+          # @option options [integer] :limit
+          #   The maximum number of items to return.
+          # @option options [string] :log_event_type
+          #   The event type of log events to be returned.
+          # @option options [integer] :max_date_created
+          #   The latest timestamp of the log to retrieve (epoch microseconds).
+          # @option options [integer] :min_date_created
+          #   The earliest timestamp of the log to retrieve (epoch microseconds).
+          # @option options [string] :min_log_level
+          #   The minimum log level of the log events to be returned. Defaults to 'info'. Acceptable values (in order of relative importance from smallest to largest) are ('trace', 'debug', 'info', 'warn', 'error', 'fatal').
+          # @option options [string] :sort_direction
+          #   The direction you want the data sorted by (always by timestamp).
+          # @option options [string] :source
+          #   The source of log events to be returned. Acceptable values are ('slack', 'developer').
+          # @option options [string] :team_id
+          #   The team who owns this log.
+          # @option options [string] :trace_id
+          #   The trace id of log events to be returned.
+          # @see https://api.slack.com/methods/apps.activities.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.activities/apps.activities.list.json
+          def apps_activities_list(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            if block_given?
+              Pagination::Cursor.new(self, :apps_activities_list, options).each do |page|
+                yield page
+              end
+            else
+              post('apps.activities.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsAuthExternal
+          #
+          # Delete external auth tokens only on the Slack side
+          #
+          # @option options [string] :app_id
+          #   The id of the app whose tokens you want to delete.
+          # @option options [string] :external_token_id
+          #   The id of the token that you want to delete.
+          # @option options [string] :provider_key
+          #   The provider key of the provider whose tokens you want to delete.
+          # @see https://api.slack.com/methods/apps.auth.external.delete
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.auth.external/apps.auth.external.delete.json
+          def apps_auth_external_delete(options = {})
+            post('apps.auth.external.delete', options)
+          end
+
+          #
+          # Get the access token for the provided token ID
+          #
+          # @option options [string] :external_token_id
+          #   The id of the token you want to get the token for.
+          # @option options [boolean] :force_refresh
+          #   Always refresh existing token before returning even when the token has not expired.
+          # @see https://api.slack.com/methods/apps.auth.external.get
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.auth.external/apps.auth.external.get.json
+          def apps_auth_external_get(options = {})
+            raise ArgumentError, 'Required arguments :external_token_id missing' if options[:external_token_id].nil?
+            post('apps.auth.external.get', options)
+          end
+        end
+      end
+    end
+  end
+end