slack-ruby-client 2.7.0 → 3.0.0

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

@@ -9,14 +9,14 @@ module Slack
           #
           # Download form responses of a workflow
           #
-          # @option options [string] :step_id
-          #   The ID of the OpenForm step to export.
+          # @option options [string] :workflow_id
+          #   The workflow ID, starts with Wf*.
           # @option options [string] :workflow
           #   The workflow encoded ID or workflow reference.
           # @option options [string] :workflow_app_id
           #   The app tied to the workflow reference.
-          # @option options [string] :workflow_id
-          #   The workflow ID, starts with Wf*.
+          # @option options [string] :step_id
+          #   The ID of the OpenForm step to export.
           # @see https://api.slack.com/methods/functions.workflows.steps.responses.export
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/functions.workflows.steps.responses/functions.workflows.steps.responses.export.json
           def functions_workflows_steps_responses_export(options = {})

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

@@ -7,7 +7,7 @@ module Slack
       module Endpoints
         module Migration
           #
-          # For Enterprise Grid workspaces, map local user IDs to global user IDs
+          # For Enterprise organization workspaces, map local user IDs to global user IDs
           #
           # @option options [array] :users
           #   A comma-separated list of user ids, up to 400 per request.

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

@@ -15,10 +15,10 @@ module Slack
           #   Issued when you created your application. If possible, avoid sending client_id and client_secret as parameters in your request and instead supply the Client ID and Client Secret using the HTTP Basic authentication scheme.
           # @option options [string] :code
           #   The code param returned via the OAuth callback.
-          # @option options [string] :grant_type
-          #   The grant_type param as described in the OAuth spec.
           # @option options [string] :redirect_uri
           #   This must match the originally submitted URI (if one was sent).
+          # @option options [string] :grant_type
+          #   The grant_type param as described in the OAuth spec.
           # @option options [string] :refresh_token
           #   The refresh_token param as described in the OAuth spec.
           # @see https://api.slack.com/methods/oauth.v2.access

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

@@ -15,10 +15,10 @@ module Slack
           #   Issued when you created your application.
           # @option options [string] :code
           #   The code param returned via the OAuth callback.
-          # @option options [enum] :grant_type
-          #   The grant_type param as described in the OAuth spec.
           # @option options [string] :redirect_uri
           #   This must match the originally submitted URI (if one was sent).
+          # @option options [enum] :grant_type
+          #   The grant_type param as described in the OAuth spec.
           # @option options [string] :refresh_token
           #   The refresh_token param as described in the OAuth spec.
           # @see https://api.slack.com/methods/openid.connect.token

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

@@ -48,16 +48,16 @@ module Slack
           #
           # Lists reactions made by a user.
           #
-          # @option options [string] :cursor
-          #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
+          # @option options [user] :user
+          #   Show reactions made by this user. Defaults to the authed user.
           # @option options [boolean] :full
           #   If true always return the complete reaction list.
+          # @option options [string] :cursor
+          #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
           # @option options [integer] :limit
           #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
           # @option options [string] :team_id
           #   encoded team id to list reactions in, required if org token is used.
-          # @option options [user] :user
-          #   Show reactions made by this user. Defaults to the authed user.
           # @see https://api.slack.com/methods/reactions.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reactions/reactions.list.json
           def reactions_list(options = {})
@@ -76,12 +76,12 @@ module Slack
           #
           # @option options [string] :name
           #   Reaction (emoji) name.
-          # @option options [channel] :channel
-          #   Channel where the message to remove reaction from was posted.
           # @option options [file] :file
           #   File to remove reaction from.
           # @option options [string] :file_comment
           #   File comment to remove reaction from.
+          # @option options [channel] :channel
+          #   Channel where the message to remove reaction from was posted.
           # @option options [string] :timestamp
           #   Timestamp of the message to remove reaction from.
           # @see https://api.slack.com/methods/reactions.remove

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

@@ -13,12 +13,12 @@ module Slack
           #   The content of the reminder.
           # @option options [string] :time
           #   Can also take a type of integer. When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday").
-          # @option options [object] :recurrence
-          #   Specify the repeating behavior of a reminder. Available options: daily, weekly, monthly, or yearly. If weekly, may further specify the days of the week.
-          # @option options [string] :team_id
-          #   Encoded team id, required if org token is used.
           # @option options [user] :user
           #   No longer supported - reminders cannot be set for other users. Previously, was the user who would receive the reminder.
+          # @option options [string] :team_id
+          #   Encoded team id, required if org token is used.
+          # @option options [object] :recurrence
+          #   Specify the repeating behavior of a reminder. Available options: daily, weekly, monthly, or yearly. If weekly, may further specify the days of the week.
           # @see https://api.slack.com/methods/reminders.add
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.add.json
           def reminders_add(options = {})

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

@@ -18,6 +18,29 @@ module Slack
           def rtm_connect(options = {})
             post('rtm.connect', options)
           end
+
+          #
+          # Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead.
+          #
+          # @option options [boolean] :simple_latest
+          #   Return timestamp only for latest message object of each channel (improves performance).
+          # @option options [boolean] :no_unreads
+          #   Skip unread counts for each channel (improves performance).
+          # @option options [boolean] :mpim_aware
+          #   Returns MPIMs to the client in the API response.
+          # @option options [boolean] :presence_sub
+          #   Only deliver presence events when requested by subscription. See presence subscriptions.
+          # @option options [boolean] :batch_presence_aware
+          #   Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.
+          # @option options [boolean] :no_latest
+          #   Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1.
+          # @option options [boolean] :include_locale
+          #   Set this to true to receive the locale for users and channels. Defaults to false.
+          # @see https://api.slack.com/methods/rtm.start
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/rtm/rtm.start.json
+          def rtm_start(options = {})
+            post('rtm.start', options)
+          end
         end
       end
     end

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

@@ -9,10 +9,10 @@ module Slack
           #
           # Searches for messages and files matching a query.
           #
-          # @option options [string] :query
-          #   Search query. May contains booleans, etc.
           # @option options [boolean] :highlight
           #   Pass a value of true to enable query highlight markers (see below).
+          # @option options [string] :query
+          #   Search query. May contains booleans, etc.
           # @option options [string] :sort
           #   Return matches sorted by either score or timestamp.
           # @option options [enum] :sort_dir
@@ -29,10 +29,10 @@ module Slack
           #
           # Searches for files matching a query.
           #
-          # @option options [string] :query
-          #   Search query.
           # @option options [boolean] :highlight
           #   Pass a value of true to enable query highlight markers (see below).
+          # @option options [string] :query
+          #   Search query.
           # @option options [string] :sort
           #   Return matches sorted by either score or timestamp.
           # @option options [enum] :sort_dir
@@ -49,12 +49,12 @@ module Slack
           #
           # Searches for messages matching a query.
           #
-          # @option options [string] :query
-          #   Search query.
-          # @option options [string] :cursor
-          #   Use this when getting results with cursormark pagination. For first call send * for subsequent calls, send the value of next_cursor returned in the previous call's results.
           # @option options [boolean] :highlight
           #   Pass a value of true to enable query highlight markers (see below).
+          # @option options [string] :cursor
+          #   Use this when getting results with cursormark pagination. For first call send * for subsequent calls, send the value of next_cursor returned in the previous call's results.
+          # @option options [string] :query
+          #   Search query.
           # @option options [string] :sort
           #   Return matches sorted by either score or timestamp.
           # @option options [enum] :sort_dir

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module SlackLists
+          #
+          # Create a List.
+          #
+          # @option options [string] :name
+          #   Name of the List.
+          # @option options [array] :description_blocks
+          #   A rich text description of the List.
+          # @option options [array] :schema
+          #   Column definition for the List.
+          # @option options [string] :copy_from_list_id
+          #   ID of the List to copy.
+          # @option options [boolean] :include_copied_list_records
+          #   Boolean indicating whether to include records when a List is copied.
+          # @option options [boolean] :todo_mode
+          #   Boolean indicating whether the List should be used to track todo tasks.
+          # @see https://api.slack.com/methods/slackLists.create
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/slackLists/slackLists.create.json
+          def slackLists_create(options = {})
+            raise ArgumentError, 'Required arguments :name missing' if options[:name].nil?
+            post('slackLists.create', options)
+          end
+
+          #
+          # Update a List.
+          #
+          # @option options [Object] :id
+          #   The ID of the List to update.
+          # @option options [string] :name
+          #   The updated name of the List.
+          # @option options [array] :description_blocks
+          #   A rich text description of the List.
+          # @option options [boolean] :todo_mode
+          #   Boolean indicating whether the List should be in todo mode.
+          # @see https://api.slack.com/methods/slackLists.update
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/slackLists/slackLists.update.json
+          def slackLists_update(options = {})
+            raise ArgumentError, 'Required arguments :id missing' if options[:id].nil?
+            post('slackLists.update', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module SlackListsAccess
+          #
+          # Revoke access to a List for specified entities.
+          #
+          # @option options [Object] :list_id
+          #   Encoded ID of the List.
+          # @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
+          #   List of users you wish to update access for. Can only be used if channel_ids is not provided.
+          # @see https://api.slack.com/methods/slackLists.access.delete
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/slackLists.access/slackLists.access.delete.json
+          def slackLists_access_delete(options = {})
+            raise ArgumentError, 'Required arguments :list_id missing' if options[:list_id].nil?
+            post('slackLists.access.delete', options)
+          end
+
+          #
+          # Set the access level to a List for specified entities.
+          #
+          # @option options [Object] :list_id
+          #   Encoded ID of the List.
+          # @option options [Object] :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
+          #   List of users you wish to update access for. Can only be used if channel_ids is not provided.
+          # @see https://api.slack.com/methods/slackLists.access.set
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/slackLists.access/slackLists.access.set.json
+          def slackLists_access_set(options = {})
+            raise ArgumentError, 'Required arguments :list_id missing' if options[:list_id].nil?
+            raise ArgumentError, 'Required arguments :access_level missing' if options[:access_level].nil?
+            post('slackLists.access.set', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/slackLists_download.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 SlackListsDownload
+          #
+          # Retrieve List download URL from an export job to download List contents.
+          #
+          # @option options [string] :list_id
+          #   ID of the List to export.
+          # @option options [string] :job_id
+          #   The ID of the recently started job to export the List.
+          # @see https://api.slack.com/methods/slackLists.download.get
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/slackLists.download/slackLists.download.get.json
+          def slackLists_download_get(options = {})
+            raise ArgumentError, 'Required arguments :list_id missing' if options[:list_id].nil?
+            raise ArgumentError, 'Required arguments :job_id missing' if options[:job_id].nil?
+            post('slackLists.download.get', options)
+          end
+
+          #
+          # Initiate a job to export List contents.
+          #
+          # @option options [string] :list_id
+          #   ID of the List to export.
+          # @option options [boolean] :include_archived
+          # @see https://api.slack.com/methods/slackLists.download.start
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/slackLists.download/slackLists.download.start.json
+          def slackLists_download_start(options = {})
+            raise ArgumentError, 'Required arguments :list_id missing' if options[:list_id].nil?
+            post('slackLists.download.start', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module SlackListsItems
+          #
+          # Add a new item to an existing List.
+          #
+          # @option options [Object] :list_id
+          #   ID of the List to add the item to.
+          # @option options [Object] :duplicated_item_id
+          #   ID of the record to make a copy of.
+          # @option options [Object] :parent_item_id
+          #   ID of the parent record for this subtask.
+          # @option options [array] :initial_fields
+          #   Initial item data.
+          # @see https://api.slack.com/methods/slackLists.items.create
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/slackLists.items/slackLists.items.create.json
+          def slackLists_items_create(options = {})
+            raise ArgumentError, 'Required arguments :list_id missing' if options[:list_id].nil?
+            post('slackLists.items.create', options)
+          end
+
+          #
+          # Deletes an item from an existing List.
+          #
+          # @option options [string] :list_id
+          #   ID of the List containing the item.
+          # @option options [string] :id
+          #   ID of item to delete.
+          # @see https://api.slack.com/methods/slackLists.items.delete
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/slackLists.items/slackLists.items.delete.json
+          def slackLists_items_delete(options = {})
+            raise ArgumentError, 'Required arguments :list_id missing' if options[:list_id].nil?
+            raise ArgumentError, 'Required arguments :id missing' if options[:id].nil?
+            post('slackLists.items.delete', options)
+          end
+
+          #
+          # Deletes multiple items from an existing List.
+          #
+          # @option options [string] :list_id
+          #   ID of the List containing the items.
+          # @option options [array] :ids
+          #   IDs of items to delete.
+          # @see https://api.slack.com/methods/slackLists.items.deleteMultiple
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/slackLists.items/slackLists.items.deleteMultiple.json
+          def slackLists_items_deleteMultiple(options = {})
+            raise ArgumentError, 'Required arguments :list_id missing' if options[:list_id].nil?
+            raise ArgumentError, 'Required arguments :ids missing' if options[:ids].nil?
+            post('slackLists.items.deleteMultiple', options)
+          end
+
+          #
+          # Get a row from a List.
+          #
+          # @option options [string] :list_id
+          #   ID of the List.
+          # @option options [string] :id
+          #   ID of the row to get.
+          # @option options [boolean] :include_is_subscribed
+          #   Set to true to include is_subscribed data for the returned List row.
+          # @see https://api.slack.com/methods/slackLists.items.info
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/slackLists.items/slackLists.items.info.json
+          def slackLists_items_info(options = {})
+            raise ArgumentError, 'Required arguments :list_id missing' if options[:list_id].nil?
+            raise ArgumentError, 'Required arguments :id missing' if options[:id].nil?
+            post('slackLists.items.info', options)
+          end
+
+          #
+          # Get records from a List.
+          #
+          # @option options [string] :list_id
+          #   ID of the List.
+          # @option options [integer] :limit
+          #   The maximum number of records to return.
+          # @option options [string] :cursor
+          #   Next cursor for pagination.
+          # @option options [boolean] :archived
+          #   Boolean indicating whether archived items or normal items should be returned.
+          # @see https://api.slack.com/methods/slackLists.items.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/slackLists.items/slackLists.items.list.json
+          def slackLists_items_list(options = {})
+            raise ArgumentError, 'Required arguments :list_id missing' if options[:list_id].nil?
+            if block_given?
+              Pagination::Cursor.new(self, :slackLists_items_list, options).each do |page|
+                yield page
+              end
+            else
+              post('slackLists.items.list', options)
+            end
+          end
+
+          #
+          # Updates cells in a List.
+          #
+          # @option options [string] :list_id
+          #   ID of the List to add or update cells.
+          # @option options [array] :cells
+          #   Cells to update.
+          # @see https://api.slack.com/methods/slackLists.items.update
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/slackLists.items/slackLists.items.update.json
+          def slackLists_items_update(options = {})
+            raise ArgumentError, 'Required arguments :list_id missing' if options[:list_id].nil?
+            raise ArgumentError, 'Required arguments :cells missing' if options[:cells].nil?
+            post('slackLists.items.update', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -9,7 +9,7 @@ module Slack
           #
           # Gets the access logs for the current team.
           #
-          # @option options [string] :before
+          # @option options [["string", "string"]] :before
           #   End of time range of logs to include in results (inclusive).
           # @option options [string] :cursor
           #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
@@ -36,10 +36,10 @@ module Slack
           #   Set cursor to next_cursor returned by previous call, to indicate from where you want to list next page of users list. Default value fetches the first page.
           # @option options [integer] :limit
           #   The maximum number of items to return.
-          # @option options [string] :team_id
-          #   encoded team id to get the billable information from, required if org token is used.
           # @option options [user] :user
           #   A user to retrieve the billable information for. Defaults to all users.
+          # @option options [string] :team_id
+          #   encoded team id to get the billable information from, required if org token is used.
           # @see https://api.slack.com/methods/team.billableInfo
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/team/team.billableInfo.json
           def team_billableInfo(options = {})

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

@@ -21,20 +21,20 @@ module Slack
           #
           # Returns a list of all the external teams connected and details about the connection.
           #
-          # @option options [enum] :connection_status_filter
-          #   Status of the connected team.
-          # @option options [string] :cursor
-          #   Paginate through collections of data by setting parameter to the team_id attribute returned by a previous request's response_metadata. If not provided, the first page of the collection is returned. See pagination for more detail.
           # @option options [integer] :limit
           #   The maximum number of items to return per page.
-          # @option options [array] :slack_connect_pref_filter
-          #   Filters connected orgs by Slack Connect pref override(s). Value can be: approved_orgs_only allow_sc_file_uploads profile_visibility away_team_sc_invite_permissions accept_sc_invites sc_mpdm_to_private require_sc_channel_for_sc_dm external_awareness_context_bar.
-          # @option options [enum] :sort_direction
-          #   Direction to sort in asc or desc.
+          # @option options [string] :cursor
+          #   Paginate through collections of data by setting parameter to the team_id attribute returned by a previous request's response_metadata. If not provided, the first page of the collection is returned. See pagination for more detail.
           # @option options [enum] :sort_field
           #   Name of the parameter that we are sorting by.
+          # @option options [enum] :sort_direction
+          #   Direction to sort in asc or desc.
+          # @option options [array] :slack_connect_pref_filter
+          #   Filters connected orgs by Slack Connect pref override(s). Value can be: approved_orgs_only allow_sc_file_uploads profile_visibility away_team_sc_invite_permissions accept_sc_invites sc_mpdm_to_private require_sc_channel_for_sc_dm external_awareness_context_bar.
           # @option options [array] :workspace_filter
           #   Shows connected orgs which are connected on a specified encoded workspace ID.
+          # @option options [enum] :connection_status_filter
+          #   Status of the connected team.
           # @see https://api.slack.com/methods/team.externalTeams.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/team.externalTeams/team.externalTeams.list.json
           def team_externalTeams_list(options = {})

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

@@ -9,22 +9,22 @@ module Slack
           #
           # Create a User Group.
           #
-          # @option options [string] :name
-          #   A name for the User Group. Must be unique among User Groups.
-          # @option options [array] :additional_channels
-          #   A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.
           # @option options [array] :channels
           #   A comma separated string of encoded channel IDs for which the User Group uses as a default.
+          # @option options [array] :additional_channels
+          #   A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.
           # @option options [string] :description
           #   A short description of the User Group.
-          # @option options [boolean] :enable_section
-          #   Configure this user group to show as a sidebar section for all group members. Note: Only relevant if group has 1 or more default channels added.
           # @option options [string] :handle
           #   A mention handle. Must be unique among channels, users and User Groups.
           # @option options [boolean] :include_count
           #   Include the number of users in each User Group.
+          # @option options [string] :name
+          #   A name for the User Group. Must be unique among User Groups.
           # @option options [string] :team_id
           #   Encoded team id where the user group has to be created, required if org token is used.
+          # @option options [boolean] :enable_section
+          #   Configure this user group to show as a sidebar section for all group members. Note: Only relevant if group has 1 or more default channels added.
           # @see https://api.slack.com/methods/usergroups.create
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.create.json
           def usergroups_create(options = {})
@@ -35,12 +35,12 @@ module Slack
           #
           # Disable an existing User Group.
           #
-          # @option options [Object] :usergroup
-          #   The encoded ID of the User Group to disable.
           # @option options [boolean] :include_count
           #   Include the number of users in the User Group.
           # @option options [Object] :team_id
           #   Encoded target team id where the user group is, required if org token is used.
+          # @option options [Object] :usergroup
+          #   The encoded ID of the User Group to disable.
           # @see https://api.slack.com/methods/usergroups.disable
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.disable.json
           def usergroups_disable(options = {})
@@ -51,12 +51,12 @@ module Slack
           #
           # Enable a User Group.
           #
-          # @option options [string] :usergroup
-          #   The encoded ID of the User Group to enable.
           # @option options [boolean] :include_count
           #   Include the number of users in the User Group.
           # @option options [string] :team_id
           #   Encoded team id where the user group is, required if org token is used.
+          # @option options [string] :usergroup
+          #   The encoded ID of the User Group to enable.
           # @see https://api.slack.com/methods/usergroups.enable
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.enable.json
           def usergroups_enable(options = {})
@@ -70,11 +70,11 @@ module Slack
           # @option options [boolean] :include_count
           #   Include the number of users in each User Group.
           # @option options [boolean] :include_disabled
-          #   Include disabled User Groups.
+          #   Include results for disabled User Groups.
           # @option options [boolean] :include_users
           #   Include the list of users for each User Group.
           # @option options [string] :team_id
-          #   encoded team id to list user groups in, required if org token is used.
+          #   The user group's encoded team ID. Required if org token is used.
           # @see https://api.slack.com/methods/usergroups.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.list.json
           def usergroups_list(options = {})
@@ -84,16 +84,12 @@ module Slack
           #
           # Update an existing User Group.
           #
-          # @option options [Object] :usergroup
-          #   The encoded ID of the User Group to update.
-          # @option options [array] :additional_channels
-          #   A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.
           # @option options [array] :channels
           #   A comma separated string of encoded channel IDs for which the User Group uses as a default.
+          # @option options [array] :additional_channels
+          #   A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.
           # @option options [string] :description
           #   A short description of the User Group.
-          # @option options [boolean] :enable_section
-          #   Configure this user group to show as a sidebar section for all group members. Note: Only relevant if group has 1 or more default channels added.
           # @option options [string] :handle
           #   A mention handle. Must be unique among channels, users and User Groups.
           # @option options [boolean] :include_count
@@ -102,6 +98,10 @@ module Slack
           #   A name for the User Group. Must be unique among User Groups.
           # @option options [Object] :team_id
           #   encoded team id where the user group exists, required if org token is used.
+          # @option options [Object] :usergroup
+          #   The encoded ID of the User Group to update.
+          # @option options [boolean] :enable_section
+          #   Configure this user group to show as a sidebar section for all group members. Note: Only relevant if group has 1 or more default channels added.
           # @see https://api.slack.com/methods/usergroups.update
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.update.json
           def usergroups_update(options = {})

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

@@ -9,12 +9,12 @@ module Slack
           #
           # List all users in a User Group.
           #
-          # @option options [string] :usergroup
-          #   The encoded ID of the User Group to list users for.
           # @option options [boolean] :include_disabled
-          #   Allow results that involve disabled User Groups.
+          #   Include results for disabled User Groups.
+          # @option options [string] :usergroup
+          #   The encoded ID of the User Group.
           # @option options [string] :team_id
-          #   encoded team id where the user group exists, required if org token is used.
+          #   The user group's encoded team ID. Required if org token is used.
           # @see https://api.slack.com/methods/usergroups.users.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups.users/usergroups.users.list.json
           def usergroups_users_list(options = {})
@@ -25,18 +25,18 @@ module Slack
           #
           # Update the list of users for a user group.
           #
+          # @option options [boolean] :include_count
+          #   Include the number of users in the user group.
+          # @option options [string] :team_id
+          #   encoded team id where the user group exists, required if org token is used.
           # @option options [string] :usergroup
           #   The encoded ID of the user group to update.
           # @option options [array] :users
           #   A comma separated string of encoded user IDs that represent the entire list of users for the user group.
           # @option options [array] :additional_channels
           #   A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.
-          # @option options [boolean] :include_count
-          #   Include the number of users in the user group.
           # @option options [boolean] :is_shared
           #   Boolean to identify if the API is getting called when a shared section is getting shared.
-          # @option options [string] :team_id
-          #   encoded team id where the user group exists, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.users.update
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups.users/usergroups.users.update.json
           def usergroups_users_update(options = {})