slack-ruby-client 2.7.0 → 3.0.0

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

@@ -14,7 +14,6 @@ module Slack
           # @option options [array] :ids
           #   IDs of items to be deleted.
           # @option options [Object] :app_id
-          #   .
           # @see https://api.slack.com/methods/apps.datastore.bulkDelete
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.datastore/apps.datastore.bulkDelete.json
           def apps_datastore_bulkDelete(options = {})
@@ -31,7 +30,6 @@ module Slack
           # @option options [array] :ids
           #   items' ids.
           # @option options [Object] :app_id
-          #   .
           # @see https://api.slack.com/methods/apps.datastore.bulkGet
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.datastore/apps.datastore.bulkGet.json
           def apps_datastore_bulkGet(options = {})
@@ -48,7 +46,6 @@ module Slack
           # @option options [array] :items
           #   attribute names and values of the items; limit of 25.
           # @option options [Object] :app_id
-          #   .
           # @see https://api.slack.com/methods/apps.datastore.bulkPut
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.datastore/apps.datastore.bulkPut.json
           def apps_datastore_bulkPut(options = {})
@@ -62,14 +59,14 @@ module Slack
           #
           # @option options [string] :datastore
           #   Name of the datastore.
-          # @option options [Object] :app_id
-          #   Required if calling with user token.
           # @option options [string] :expression
-          #   A query filter expression https://api.slack.com/future/datastores.
+          #   A query filter expression.
           # @option options [object] :expression_attributes
           #   A map of attributes referenced in expression.
           # @option options [object] :expression_values
           #   A map of values referenced in expression.
+          # @option options [Object] :app_id
+          #   Required if calling with user token.
           # @see https://api.slack.com/methods/apps.datastore.count
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.datastore/apps.datastore.count.json
           def apps_datastore_count(options = {})
@@ -85,7 +82,6 @@ module Slack
           # @option options [string] :id
           #   item id.
           # @option options [Object] :app_id
-          #   .
           # @see https://api.slack.com/methods/apps.datastore.delete
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.datastore/apps.datastore.delete.json
           def apps_datastore_delete(options = {})
@@ -102,7 +98,6 @@ module Slack
           # @option options [string] :id
           #   item id.
           # @option options [Object] :app_id
-          #   .
           # @see https://api.slack.com/methods/apps.datastore.get
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.datastore/apps.datastore.get.json
           def apps_datastore_get(options = {})
@@ -119,7 +114,6 @@ module Slack
           # @option options [object] :item
           #   attribute names and values of the item.
           # @option options [Object] :app_id
-          #   .
           # @see https://api.slack.com/methods/apps.datastore.put
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.datastore/apps.datastore.put.json
           def apps_datastore_put(options = {})
@@ -133,16 +127,16 @@ module Slack
           #
           # @option options [string] :datastore
           #   Name of the datastore.
-          # @option options [Object] :app_id
-          #   Required if calling with user token.
-          # @option options [string] :cursor
-          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
           # @option options [string] :expression
-          #   A query filter expression https://api.slack.com/future/datastores.
+          #   A query filter expression.
           # @option options [object] :expression_attributes
           #   A map of attributes referenced in expression.
           # @option options [object] :expression_values
           #   A map of values referenced in expression.
+          # @option options [Object] :app_id
+          #   Required if calling with user token.
+          # @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 evaluate for a given request (not necessarily the number of matching items). If the given request dataset size exceeds 1 MB before reaching the limit, the returned item count will likely be less than the limit. In any case where there are more items available beyond an imposed limit, a next_cursor value will be provided for use in subsequent requests.
           # @see https://api.slack.com/methods/apps.datastore.query
@@ -166,7 +160,6 @@ module Slack
           # @option options [object] :item
           #   attribute names and values to be updated.
           # @option options [Object] :app_id
-          #   .
           # @see https://api.slack.com/methods/apps.datastore.update
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.datastore/apps.datastore.update.json
           def apps_datastore_update(options = {})

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

@@ -10,11 +10,8 @@ module Slack
           # Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.
           #
           # @option options [string] :event_context
-          #   .
           # @option options [string] :cursor
-          #   .
           # @option options [integer] :limit
-          #   .
           # @see https://api.slack.com/methods/apps.event.authorizations.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.event.authorizations/apps.event.authorizations.list.json
           def apps_event_authorizations_list(options = {})

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

@@ -9,7 +9,7 @@ module Slack
           #
           # Create an app from an app manifest.
           #
-          # @option options [manifest object as string] :manifest
+          # @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.
           # @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
@@ -46,15 +46,15 @@ module Slack
           #
           # Update an app from an app manifest
           #
+          # @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.
           # @option options [Object] :app_id
           #   The ID of the app whose configuration you want to update.
-          # @option options [manifest object as string] :manifest
-          #   A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one. As this method entirely replaces any previous configuration, manifest must contain both unmodified and modified fields.
           # @see https://api.slack.com/methods/apps.manifest.update
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.manifest/apps.manifest.update.json
           def apps_manifest_update(options = {})
-            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
             raise ArgumentError, 'Required arguments :manifest missing' if options[:manifest].nil?
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
             options = encode_options_as_json(options, %i[manifest])
             post('apps.manifest.update', options)
           end
@@ -62,7 +62,7 @@ module Slack
           #
           # Validate an app manifest
           #
-          # @option options [manifest object as string] :manifest
+          # @option options [string] :manifest
           #   The manifest to be validated. Will be validated against the app manifest schema - read our guide.
           # @option options [Object] :app_id
           #   The ID of the app whose configuration you want to validate.

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

@@ -16,15 +16,31 @@ module Slack
           # @option options [array] :channel_types
           #   Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.
           # @option options [array] :content_types
-          #   Content types to include, a comma-separated list of any combination of messages, files.
+          #   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.
+          # @option options [integer] :before
+          #   UNIX timestamp filter. If present, filters for results before this date.
+          # @option options [integer] :after
+          #   UNIX timestamp filter. If present, filters for results after this date.
+          # @option options [boolean] :include_context_messages
+          #   Whether to include context messages surrounding the main message result. Defaults to false if unspecified.
           # @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.
-          # @option options [boolean] :include_bots
-          #   If you want the results to include bots.
           # @option options [integer] :limit
           #   Number of results to return, up to a max of 20. Defaults to 20.
+          # @option options [enum] :sort
+          #   The field to sort the results by. Defaults to score. Can be one of: score, timestamp.
+          # @option options [enum] :sort_dir
+          #   The direction to sort the results by. Defaults to desc.
+          # @option options [boolean] :include_message_blocks
+          #   Whether to return the message blocks in the response.
+          # @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).
           # @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 = {})
@@ -37,6 +53,15 @@ module Slack
               post('assistant.search.context', options)
             end
           end
+
+          #
+          # Returns search capabilities on a given team.
+          #
+          # @see https://api.slack.com/methods/assistant.search.info
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/assistant.search/assistant.search.info.json
+          def assistant_search_info(options = {})
+            post('assistant.search.info', options)
+          end
         end
       end
     end

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

@@ -11,16 +11,16 @@ module Slack
           #
           # @option options [Object] :channel_id
           #   Channel ID containing the assistant thread.
-          # @option options [string] :status
-          #   Status of the specified bot user, e.g. 'is thinking...'.
           # @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...'.
           # @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 = {})
             raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
-            raise ArgumentError, 'Required arguments :status missing' if options[:status].nil?
             raise ArgumentError, 'Required arguments :thread_ts missing' if options[:thread_ts].nil?
+            raise ArgumentError, 'Required arguments :status missing' if options[:status].nil?
             post('assistant.threads.setStatus', options)
           end
 
@@ -29,18 +29,18 @@ module Slack
           #
           # @option options [Object] :channel_id
           #   Channel ID containing the assistant thread.
-          # @option options [Object] :prompts
-          #   Each prompt should be supplied with its title and message attribute.
           # @option options [string] :thread_ts
           #   Message timestamp of the thread to set suggested prompts for.
+          # @option options [Object] :prompts
+          #   Each prompt should be supplied with its title and message attribute.
           # @option options [string] :title
           #   Title for the list of provided prompts. For example: Suggested Prompts, Related Questions.
           # @see https://api.slack.com/methods/assistant.threads.setSuggestedPrompts
           # @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 :prompts missing' if options[:prompts].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/auth.rb

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

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

@@ -9,12 +9,12 @@ module Slack
           #
           # Obtain a full list of workspaces your org-wide app has been approved for.
           #
+          # @option options [integer] :limit
+          #   The maximum number of workspaces to return. Must be a positive integer no larger than 1000.
           # @option options [string] :cursor
           #   Set cursor to next_cursor returned by the previous call to list items in the next page.
           # @option options [boolean] :include_icon
           #   Whether to return icon paths for each workspace. An icon path represents a URI pointing to the image signifying the workspace.
-          # @option options [integer] :limit
-          #   The maximum number of workspaces to return. Must be a positive integer no larger than 1000.
           # @see https://api.slack.com/methods/auth.teams.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/auth.teams/auth.teams.list.json
           def auth_teams_list(options = {})

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

@@ -13,16 +13,16 @@ module Slack
           #   Channel to add bookmark in.
           # @option options [string] :title
           #   Title for the bookmark.
+          # @option options [string] :link
+          #   Link to bookmark.
           # @option options [string] :type
           #   Type of the bookmark i.e link.
-          # @option options [enum] :access_level
-          #   The level that we are setting the file's permission to (read or write).
           # @option options [string] :emoji
           #   Emoji tag to apply to the link.
           # @option options [string] :entity_id
           #   ID of the entity being bookmarked. Only applies to message and file types.
-          # @option options [string] :link
-          #   Link to bookmark.
+          # @option options [enum] :access_level
+          #   The level that we are setting the file's permission to (read or write).
           # @option options [string] :parent_id
           #   Id of this bookmark's parent.
           # @see https://api.slack.com/methods/bookmarks.add
@@ -37,21 +37,21 @@ module Slack
           #
           # Edit bookmark.
           #
-          # @option options [string] :bookmark_id
-          #   Bookmark to update.
           # @option options [string] :channel_id
           #   Channel to update bookmark in.
-          # @option options [string] :emoji
-          #   Emoji tag to apply to the link.
-          # @option options [string] :link
-          #   Link to bookmark.
+          # @option options [string] :bookmark_id
+          #   Bookmark to update.
           # @option options [string] :title
           #   Title for the bookmark.
+          # @option options [string] :link
+          #   Link to bookmark.
+          # @option options [string] :emoji
+          #   Emoji tag to apply to the link.
           # @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 :bookmark_id missing' if options[:bookmark_id].nil?
             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
 
@@ -70,17 +70,17 @@ module Slack
           #
           # Remove bookmark from the channel.
           #
-          # @option options [string] :bookmark_id
-          #   Bookmark to remove.
           # @option options [string] :channel_id
           #   Channel to remove bookmark.
+          # @option options [string] :bookmark_id
+          #   Bookmark to remove.
           # @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 :bookmark_id missing' if options[:bookmark_id].nil?
             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

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

@@ -11,18 +11,18 @@ module Slack
           #
           # @option options [string] :external_unique_id
           #   An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.
+          # @option options [string] :external_display_id
+          #   An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.
           # @option options [string] :join_url
           #   The URL required for a client to join the Call.
-          # @option options [string] :created_by
-          #   The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required.
-          # @option options [integer] :date_start
-          #   Unix timestamp of the call start time.
           # @option options [string] :desktop_app_join_url
           #   When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
-          # @option options [string] :external_display_id
-          #   An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.
+          # @option options [integer] :date_start
+          #   Unix timestamp of the call start time.
           # @option options [string] :title
           #   The name of the Call.
+          # @option options [string] :created_by
+          #   The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required.
           # @option options [array] :users
           #   The list of users to register as participants in the Call. Read more on how to specify users here.
           # @see https://api.slack.com/methods/calls.add
@@ -64,12 +64,12 @@ module Slack
           #
           # @option options [string] :id
           #   id returned by the calls.add method.
-          # @option options [string] :desktop_app_join_url
-          #   When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
-          # @option options [string] :join_url
-          #   The URL required for a client to join the Call.
           # @option options [string] :title
           #   The name of the Call.
+          # @option options [string] :join_url
+          #   The URL required for a client to join the Call.
+          # @option options [string] :desktop_app_join_url
+          #   When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
           # @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 = {})

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

@@ -9,12 +9,12 @@ module Slack
           #
           # Create canvas for a user
           #
-          # @option options [string] :channel_id
-          #   Channel ID of the channel the canvas will be tabbed in. This is a required field for free teams.
-          # @option options [Object] :document_content
-          #   Structure describing the type and value of the content to create.
           # @option options [string] :title
           #   Title of the newly created canvas.
+          # @option options [Object] :document_content
+          #   Structure describing the type and value of the content to create.
+          # @option options [string] :channel_id
+          #   Channel ID of the channel the canvas will be tabbed in. This is a required field for free teams.
           # @see https://api.slack.com/methods/canvases.create
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/canvases/canvases.create.json
           def canvases_create(options = {})

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

@@ -25,10 +25,10 @@ module Slack
           #
           # Sets the access level to a canvas for specified entities
           #
-          # @option options [enum] :access_level
-          #   Desired level of access.
           # @option options [Object] :canvas_id
           #   Encoded ID of the canvas.
+          # @option options [enum] :access_level
+          #   Desired level of access.
           # @option options [array] :channel_ids
           #   List of channels you wish to update access for. Can only be used if user_ids is not provided.
           # @option options [array] :user_ids
@@ -36,8 +36,8 @@ module Slack
           # @see https://api.slack.com/methods/canvases.access.set
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/canvases.access/canvases.access.set.json
           def canvases_access_set(options = {})
-            raise ArgumentError, 'Required arguments :access_level missing' if options[:access_level].nil?
             raise ArgumentError, 'Required arguments :canvas_id missing' if options[:canvas_id].nil?
+            raise ArgumentError, 'Required arguments :access_level missing' if options[:access_level].nil?
             post('canvases.access.set', options)
           end
         end