slack-ruby-client 0.11.0 → 2.7.0

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

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    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 = {})
+            raise ArgumentError, '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 = {})
+            raise ArgumentError, '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 [Object] :user_id
+          #   ID of the user 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 = {})
+            raise ArgumentError, 'Required arguments :session_id missing' if options[:session_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 [string] :user_id
+          #   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.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 = {})
+            raise ArgumentError, '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 = {})
+            raise ArgumentError, '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 up to 1,000 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 = {})
+            raise ArgumentError, 'Required arguments :user_ids missing' if options[:user_ids].nil?
+            post('admin.users.session.setSettings', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminUsersUnsupportedversions
+          #
+          # Ask Slackbot to send you an export listing all workspace members using unsupported software, presented as a zipped CSV file.
+          #
+          # @option options [integer] :date_end_of_support
+          #   Unix timestamp of the date of past or upcoming end of support cycles. If not provided will include all announced end of support cycles.
+          # @option options [integer] :date_sessions_started
+          #   Unix timestamp of a date to start looking for user sessions. If not provided will start six months ago.
+          # @see https://api.slack.com/methods/admin.users.unsupportedVersions.export
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.unsupportedVersions/admin.users.unsupportedVersions.export.json
+          def admin_users_unsupportedVersions_export(options = {})
+            post('admin.users.unsupportedVersions.export', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# 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 where all of the provided user IDs are a manager/collaborator of that workflow.
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [boolean] :is_sales_elevate
+          #   Filter workflows by their Sales Elevate status.
+          # @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 10.
+          # @option options [enum] :publish_status
+          #   Filter workflows by their published status.
+          # @option options [string] :query
+          #   A search query to filter for workflow name or description.
+          # @option options [enum] :sort
+          #   The field used to sort the returned workflows.
+          # @option options [enum] :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 [enum] :source
+          #   Source of workflow creation, either from code or workflow builder.
+          # @option options [array] :step_function_ids
+          #   Only include workflows that use all of the provided step function ids.
+          # @option options [string] :trigger_type_id
+          #   Only include workflows with this trigger type.
+          # @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/admin_workflows_triggers_types_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 AdminWorkflowsTriggersTypesPermissions
+          #
+          # list the permissions for using each trigger type
+          #
+          # @option options [array] :trigger_type_ids
+          #   The trigger types IDs for which to get the permissions.
+          # @see https://api.slack.com/methods/admin.workflows.triggers.types.permissions.lookup
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.workflows.triggers.types.permissions/admin.workflows.triggers.types.permissions.lookup.json
+          def admin_workflows_triggers_types_permissions_lookup(options = {})
+            raise ArgumentError, 'Required arguments :trigger_type_ids missing' if options[:trigger_type_ids].nil?
+            post('admin.workflows.triggers.types.permissions.lookup', options)
+          end
+
+          #
+          # Set the permissions for using a trigger type
+          #
+          # @option options [Object] :id
+          #   The trigger type ID for which to set the permissions.
+          # @option options [enum] :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.workflows.triggers.types.permissions.set
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.workflows.triggers.types.permissions/admin.workflows.triggers.types.permissions.set.json
+          def admin_workflows_triggers_types_permissions_set(options = {})
+            raise ArgumentError, 'Required arguments :id missing' if options[:id].nil?
+            raise ArgumentError, 'Required arguments :visibility missing' if options[:visibility].nil?
+            post('admin.workflows.triggers.types.permissions.set', 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
@@ -8,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

@@ -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 [string] :client_id
+          #   Issued when you created your application.
+          # @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
+          def apps_uninstall(options = {})
+            raise ArgumentError, 'Required arguments :client_id missing' if options[:client_id].nil?
+            raise ArgumentError, '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_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 [enum] :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

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