slack-ruby-client 3.0.0 → 3.2.0

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

@@ -9,6 +9,8 @@ module Slack
           #
           # Approve an app for installation on a workspace.
           #
+          # @option options [boolean] :allow_child_auto_install
+          #   Auto-create an Admin-Approved App automation rule that pre-approves future child app installs from this manager app.
           # @option options [string] :app_id
           #   The id of the app to approve.
           # @option options [string] :request_id
@@ -17,6 +19,10 @@ module Slack
           #   The ID of the workspace to approve the app on.
           # @option options [Object] :enterprise_id
           #   The ID of the enterprise to approve the app on.
+          # @option options [string] :user_scopes
+          #   User scopes to approve for the app.
+          # @option options [string] :bot_scopes
+          #   Bot scopes to approve for the app.
           # @see https://api.slack.com/methods/admin.apps.approve
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.approve.json
           def admin_apps_approve(options = {})

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

@@ -57,6 +57,21 @@ module Slack
             post('admin.conversations.bulkMove', options)
           end
 
+          #
+          # Exclude channels from Slack AI in bulk
+          #
+          # @option options [array] :channel_ids
+          #   An array of channel IDs to exclude from Slack AI.
+          # @option options [boolean] :exclude
+          #   Whether the channels should be excluded from Slack AI.
+          # @see https://api.slack.com/methods/admin.conversations.bulkSetExcludeFromSlackAi
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.bulkSetExcludeFromSlackAi.json
+          def admin_conversations_bulkSetExcludeFromSlackAi(options = {})
+            raise ArgumentError, 'Required arguments :channel_ids missing' if options[:channel_ids].nil?
+            raise ArgumentError, 'Required arguments :exclude missing' if options[:exclude].nil?
+            post('admin.conversations.bulkSetExcludeFromSlackAi', options)
+          end
+
           #
           # Convert a public channel to a private channel.
           #

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

@@ -7,12 +7,14 @@ module Slack
       module Endpoints
         module AdminFunctions
           #
-          # Look up functions by a set of apps
+          # Look up functions by a set of apps.
           #
           # @option options [Object] :team_id
           #   The team context to retrieve functions from.
           # @option options [array] :app_ids
           #   Comma-separated array of app IDs to get functions for; max 50.
+          # @option options [boolean] :include_non_distributed_functions
+          #   Whether to also include functions that are not yet distributed to any users in the function count. This is needed for admins that are approving an app request and will only work if the team owns the app.
           # @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

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

@@ -19,7 +19,7 @@ module Slack
           end
 
           #
-          # Set the visibility of a Slack function and define the users or workspaces if it is set to named_entities
+          # 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.
@@ -27,11 +27,12 @@ module Slack
           #   The function visibility.
           # @option options [array] :user_ids
           #   List of user IDs to allow for named_entities visibility.
+          # @option options [array] :permissions
+          #   Array of permissions for the function.
           # @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

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

@@ -27,6 +27,19 @@ module Slack
             post('admin.users.assign', options)
           end
 
+          #
+          # Fetches the expiration timestamp for a guest
+          #
+          # @option options [Object] :user_id
+          #   The ID of the guest user to get the expiration for.
+          # @option options [Object] :target_team
+          #   If an org token is passed in and this team is on the org, it will operate on the workspace level on the specified team. Otherwise it will operate on the org or team in context.
+          # @see https://api.slack.com/methods/admin.users.getExpiration
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.getExpiration.json
+          def admin_users_getExpiration(options = {})
+            post('admin.users.getExpiration', options)
+          end
+
           #
           # Invite a user to a workspace.
           #
@@ -72,6 +85,10 @@ module Slack
           #   Only applies with org token and no team_id. If true, return workspaces for a user even if they may be deactivated on them. If false, return workspaces for a user only when user is active on them. Default is false.
           # @option options [boolean] :only_guests
           #   If true, returns only guests and their expiration dates that belong to the team_id.
+          # @option options [boolean] :include_admins
+          #   If true, only admin users will be returned (excludes owners). Returns all admins and owners when combined with include_owners. Cannot be used together with only_guests.
+          # @option options [boolean] :include_owners
+          #   If true, only owner users will be returned. Cannot be used together with only_guests.
           # @option options [integer] :limit
           #   Limit for how many users to be retrieved per page.
           # @see https://api.slack.com/methods/admin.users.list
@@ -102,10 +119,10 @@ module Slack
           end
 
           #
-          # Set an existing regular user or owner to be a workspace admin.
+          # Set an existing regular user or owner to be a workspace or org admin.
           #
           # @option options [Object] :team_id
-          #   The ID (T1234) of the workspace.
+          #   The ID of the workspace or organization.
           # @option options [string] :user_id
           #   The ID of the user to designate as an admin.
           # @see https://api.slack.com/methods/admin.users.setAdmin
@@ -134,12 +151,12 @@ module Slack
           end
 
           #
-          # Set an existing regular user or admin to be a workspace owner.
+          # Set an existing regular user or admin to be a workspace or org owner.
           #
           # @option options [Object] :team_id
-          #   The ID (T1234) of the workspace.
+          #   The ID of the workspace or organization.
           # @option options [Object] :user_id
-          #   Id of the user to promote to owner.
+          #   ID of the user to promote to owner.
           # @see https://api.slack.com/methods/admin.users.setOwner
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setOwner.json
           def admin_users_setOwner(options = {})
@@ -152,7 +169,7 @@ module Slack
           # Set an existing guest user, admin user, or owner to be a regular user.
           #
           # @option options [Object] :team_id
-          #   The ID (T1234) of the workspace.
+          #   The ID of the workspace or organization.
           # @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

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

@@ -7,10 +7,10 @@ module Slack
       module Endpoints
         module AdminWorkflowsTriggersTypesPermissions
           #
-          # list the permissions for using each trigger type
+          # List the permissions for using each trigger type.
           #
           # @option options [array] :trigger_type_ids
-          #   The trigger types IDs for which to get the permissions.
+          #   The trigger type 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 = {})
@@ -27,11 +27,11 @@ module Slack
           #   The function visibility.
           # @option options [array] :user_ids
           #   List of user IDs to allow for named_entities visibility.
+          # @option options [object] :permissions
           # @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

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsIcon
+          #
+          # Sets the app icon
+          #
+          # @option options [Object] :app_id
+          #   The ID of the app whose icon you want to set.
+          # @option options [file] :file
+          #   File contents via multipart/form-data.
+          # @option options [string] :url
+          #   URL of a publicly hosted image.
+          # @see https://api.slack.com/methods/apps.icon.set
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.icon/apps.icon.set.json
+          def apps_icon_set(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            post('apps.icon.set', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,6 +11,8 @@ module Slack
           #
           # @option options [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.
+          # @option options [string] :team_id
+          #   When called with an org token, which specific team to create app on.
           # @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 = {})
@@ -20,7 +22,7 @@ module Slack
           end
 
           #
-          # Permanently deletes an app created through app manifests
+          # Permanently deletes an app created through app manifests. When called with a manager app token, this method can only delete apps that were created by that manager app.
           #
           # @option options [Object] :app_id
           #   The ID of the app you want to delete.
@@ -32,7 +34,7 @@ module Slack
           end
 
           #
-          # Export an app manifest from an existing app
+          # Export an app manifest from an existing app. When called with a manager app token, this method can only export apps that were created by that manager app.
           #
           # @option options [Object] :app_id
           #   The ID of the app whose configuration you want to export as a manifest.
@@ -44,7 +46,7 @@ module Slack
           end
 
           #
-          # Update an app from an app manifest
+          # Update an app from an app manifest. When called with a manager app token, this method can only update apps that were created by that manager app.
           #
           # @option options [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.

data/lib/slack/web/api/endpoints/apps_user_connection.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 AppsUserConnection
+          #
+          # Updates the connection status between a user and an app.
+          #
+          # @option options [string] :user_id
+          #   The ID of the user for the status update.
+          # @option options [enum] :status
+          #   The status that should be set for the user.
+          # @see https://api.slack.com/methods/apps.user.connection.update
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.user.connection/apps.user.connection.update.json
+          def apps_user_connection_update(options = {})
+            raise ArgumentError, 'Required arguments :user_id missing' if options[:user_id].nil?
+            raise ArgumentError, 'Required arguments :status missing' if options[:status].nil?
+            post('apps.user.connection.update', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ module Slack
       module Endpoints
         module AssistantSearch
           #
-          # Searches messages across your Slack organization—perfect for broad, specific, and real-time data retrieval.
+          # Searches messages, files, channels and users across your Slack organization.
           #
           # @option options [string] :query
           #   User prompt or search query.
@@ -18,7 +18,9 @@ module Slack
           # @option options [array] :content_types
           #   Content types to include, a comma-separated list of any combination of messages, files, channels, users.
           # @option options [boolean] :include_bots
-          #   If you want the results to include bots.
+          #   Whether the results should include bots.
+          # @option options [boolean] :include_deleted_users
+          #   Whether to include deleted users in the user search results. Defaults to false.
           # @option options [integer] :before
           #   UNIX timestamp filter. If present, filters for results before this date.
           # @option options [integer] :after
@@ -28,7 +30,7 @@ module Slack
           # @option options [Object] :context_channel_id
           #   Context channel ID to support scoping the search when applicable.
           # @option options [string] :cursor
-          #   The cursor returned by the API. Leave this blank for the first request, and use this to get the next page of results.
+          #   The cursor returned by the API. Leave this blank for the first request and use this to get the next page of results.
           # @option options [integer] :limit
           #   Number of results to return, up to a max of 20. Defaults to 20.
           # @option options [enum] :sort
@@ -40,7 +42,13 @@ module Slack
           # @option options [boolean] :highlight
           #   Whether to highlight the search query in the results. Defaults to false if unspecified.
           # @option options [array] :term_clauses
-          #   A list of term clauses. A term clause is a string with search terms. Search results returned will match every term clause specified (i.e. conjunctive normal form).
+          #   A list of term clauses. A term clause is a string with search terms. Search results returned will match every term clause specified (i.e., conjunctive normal form).
+          # @option options [string] :modifiers
+          #   A string containing only modifiers in the format of modifier:value. Search results returned will match the modifier value. For now modifiers only affect term clauses.
+          # @option options [boolean] :include_archived_channels
+          #   Whether to include archived channels in the search results.
+          # @option options [boolean] :disable_semantic_search
+          #   Whether to disable semantic search. When true, only keyword-based search is used. Defaults to false.
           # @see https://api.slack.com/methods/assistant.search.context
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/assistant.search/assistant.search.context.json
           def assistant_search_context(options = {})

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

@@ -9,12 +9,20 @@ module Slack
           #
           # Set the status for an AI assistant thread.
           #
-          # @option options [Object] :channel_id
+          # @option options [string] :channel_id
           #   Channel ID containing the assistant thread.
           # @option options [string] :thread_ts
           #   Message timestamp of the thread of where to set the status.
           # @option options [string] :status
-          #   Status of the specified bot user, e.g. 'is thinking...'.
+          #   Status of the specified bot user, e.g., 'is thinking...'. A two minute timeout applies, which will cause the status to be removed if no message has been sent.
+          # @option options [array] :loading_messages
+          #   The list of messages to rotate through as a loading indicator. Maximum of 10 messages.
+          # @option options [string] :icon_emoji
+          #   Emoji to use as the icon for this message. Overrides icon_url.
+          # @option options [string] :icon_url
+          #   Image URL to use as the icon for this message.
+          # @option options [string] :username
+          #   The bot's username to display.
           # @see https://api.slack.com/methods/assistant.threads.setStatus
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/assistant.threads/assistant.threads.setStatus.json
           def assistant_threads_setStatus(options = {})
@@ -39,7 +47,6 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/assistant.threads/assistant.threads.setSuggestedPrompts.json
           def assistant_threads_setSuggestedPrompts(options = {})
             raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
-            raise ArgumentError, 'Required arguments :thread_ts missing' if options[:thread_ts].nil?
             raise ArgumentError, 'Required arguments :prompts missing' if options[:prompts].nil?
             post('assistant.threads.setSuggestedPrompts', options)
           end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Blocks
+          #
+          # Validates blocks, messages, and views Block Kit JSON payloads.
+          #
+          # @option options [string] :blocks
+          #   A JSON-encoded array of structured blocks. Provide exactly one of blocks, view, or message.
+          # @option options [string] :message
+          #   A JSON-encoded message payload to validate. Provide exactly one of blocks, view, or message.
+          # @option options [string] :view
+          #   A JSON-encoded view payload to validate. Provide exactly one of blocks, view, or message.
+          # @see https://api.slack.com/methods/blocks.validate
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/blocks/blocks.validate.json
+          def blocks_validate(options = {})
+            options = encode_options_as_json(options, %i[blocks message view])
+            post('blocks.validate', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ module Slack
           # Add bookmark to a channel.
           #
           # @option options [string] :channel_id
-          #   Channel to add bookmark in.
+          #   Channel to add bookmark in. Required for public channels.
           # @option options [string] :title
           #   Title for the bookmark.
           # @option options [string] :link
@@ -28,7 +28,6 @@ module Slack
           # @see https://api.slack.com/methods/bookmarks.add
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/bookmarks/bookmarks.add.json
           def bookmarks_add(options = {})
-            raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
             raise ArgumentError, 'Required arguments :title missing' if options[:title].nil?
             raise ArgumentError, 'Required arguments :type missing' if options[:type].nil?
             post('bookmarks.add', options)
@@ -38,9 +37,9 @@ module Slack
           # Edit bookmark.
           #
           # @option options [string] :channel_id
-          #   Channel to update bookmark in.
+          #   Channel to update bookmark in. Required for public channels.
           # @option options [string] :bookmark_id
-          #   Bookmark to update.
+          #   Bookmark to update. Required for public channels.
           # @option options [string] :title
           #   Title for the bookmark.
           # @option options [string] :link
@@ -50,8 +49,6 @@ module Slack
           # @see https://api.slack.com/methods/bookmarks.edit
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/bookmarks/bookmarks.edit.json
           def bookmarks_edit(options = {})
-            raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
-            raise ArgumentError, 'Required arguments :bookmark_id missing' if options[:bookmark_id].nil?
             post('bookmarks.edit', options)
           end
 
@@ -59,11 +56,10 @@ module Slack
           # List bookmark for the channel.
           #
           # @option options [string] :channel_id
-          #   Channel to list bookmarks in.
+          #   Channel to list bookmarks in. Required for public channels.
           # @see https://api.slack.com/methods/bookmarks.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/bookmarks/bookmarks.list.json
           def bookmarks_list(options = {})
-            raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
             post('bookmarks.list', options)
           end
 
@@ -71,16 +67,14 @@ module Slack
           # Remove bookmark from the channel.
           #
           # @option options [string] :channel_id
-          #   Channel to remove bookmark.
+          #   Channel to remove bookmark. Required for public channels.
           # @option options [string] :bookmark_id
-          #   Bookmark to remove.
+          #   Bookmark to remove. Required for public channels.
           # @option options [string] :quip_section_id
           #   Quip section ID to unbookmark.
           # @see https://api.slack.com/methods/bookmarks.remove
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/bookmarks/bookmarks.remove.json
           def bookmarks_remove(options = {})
-            raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
-            raise ArgumentError, 'Required arguments :bookmark_id missing' if options[:bookmark_id].nil?
             post('bookmarks.remove', options)
           end
         end