slack-ruby-client 2.6.0 → 3.0.0

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 = {})

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

@@ -67,10 +67,10 @@ module Slack
           #
           # Gets information about a user.
           #
-          # @option options [user] :user
-          #   User to get info on.
           # @option options [boolean] :include_locale
           #   Set this to true to receive the locale for this user. Defaults to false.
+          # @option options [user] :user
+          #   User to get info on.
           # @see https://api.slack.com/methods/users.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.info.json
           def users_info(options = {})

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

@@ -10,7 +10,6 @@ module Slack
           # Look up an email address to see if someone is discoverable on Slack
           #
           # @option options [string] :email
-          #   .
           # @see https://api.slack.com/methods/users.discoverableContacts.lookup
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users.discoverableContacts/users.discoverableContacts.lookup.json
           def users_discoverableContacts_lookup(options = {})

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

@@ -9,12 +9,12 @@ module Slack
           #
           # Open a view for a user.
           #
-          # @option options [view as string] :view
-          #   A view payload. This must be a JSON-encoded string.
           # @option options [string] :trigger_id
           #   Exchange a trigger to post to the user.
           # @option options [string] :interactivity_pointer
           #   Exchange an interactivity pointer to post to the user.
+          # @option options [Object] :view
+          #   A view payload. This must be a JSON-encoded string.
           # @see https://api.slack.com/methods/views.open
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/views/views.open.json
           def views_open(options = {})
@@ -29,7 +29,7 @@ module Slack
           #
           # @option options [string] :user_id
           #   id of the user you want publish a view to.
-          # @option options [view as string] :view
+          # @option options [Object] :view
           #   A view payload. This must be a JSON-encoded string.
           # @option options [string] :hash
           #   A string that represents view state to protect against possible race conditions.
@@ -45,12 +45,12 @@ module Slack
           #
           # Push a view onto the stack of a root view.
           #
-          # @option options [view as string] :view
-          #   A view payload. This must be a JSON-encoded string.
           # @option options [string] :trigger_id
           #   Exchange a trigger to post to the user.
           # @option options [string] :interactivity_pointer
           #   Exchange an interactivity pointer to post to the user.
+          # @option options [Object] :view
+          #   A view payload. This must be a JSON-encoded string.
           # @see https://api.slack.com/methods/views.push
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/views/views.push.json
           def views_push(options = {})
@@ -63,12 +63,12 @@ module Slack
           #
           # Update an existing view.
           #
-          # @option options [view as string] :view
-          #   A view object. This must be a JSON-encoded string.
-          # @option options [string] :external_id
-          #   A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either view_id or external_id is required.
           # @option options [string] :view_id
           #   A unique identifier of the view to be updated. Either view_id or external_id is required.
+          # @option options [string] :external_id
+          #   A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either view_id or external_id is required.
+          # @option options [Object] :view
+          #   A view object. This must be a JSON-encoded string.
           # @option options [string] :hash
           #   A string that represents view state to protect against possible race conditions.
           # @see https://api.slack.com/methods/views.update

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module WorkflowsFeatured
+          #
+          # Add featured workflows to a channel.
+          #
+          # @option options [string] :channel_id
+          #   Channel to add featured workflow in.
+          # @option options [array] :trigger_ids
+          #   Comma-separated array of trigger IDs to add; max 15.
+          # @see https://api.slack.com/methods/workflows.featured.add
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/workflows.featured/workflows.featured.add.json
+          def workflows_featured_add(options = {})
+            raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
+            raise ArgumentError, 'Required arguments :trigger_ids missing' if options[:trigger_ids].nil?
+            post('workflows.featured.add', options)
+          end
+
+          #
+          # List the featured workflows for specified channels.
+          #
+          # @option options [array] :channel_ids
+          #   Comma-separated array of channel IDs to list featured workflows for.
+          # @see https://api.slack.com/methods/workflows.featured.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/workflows.featured/workflows.featured.list.json
+          def workflows_featured_list(options = {})
+            raise ArgumentError, 'Required arguments :channel_ids missing' if options[:channel_ids].nil?
+            post('workflows.featured.list', options)
+          end
+
+          #
+          # Remove featured workflows from a channel.
+          #
+          # @option options [string] :channel_id
+          #   Channel to remove featured workflow from.
+          # @option options [array] :trigger_ids
+          #   Comma-separated array of trigger IDs to remove; max 15.
+          # @see https://api.slack.com/methods/workflows.featured.remove
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/workflows.featured/workflows.featured.remove.json
+          def workflows_featured_remove(options = {})
+            raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
+            raise ArgumentError, 'Required arguments :trigger_ids missing' if options[:trigger_ids].nil?
+            post('workflows.featured.remove', options)
+          end
+
+          #
+          # Set featured workflows for a channel.
+          #
+          # @option options [string] :channel_id
+          #   Channel to set featured workflows in.
+          # @option options [array] :trigger_ids
+          #   Comma-separated array of trigger IDs that will replace any existing featured workflows in the channel; max 15.
+          # @see https://api.slack.com/methods/workflows.featured.set
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/workflows.featured/workflows.featured.set.json
+          def workflows_featured_set(options = {})
+            raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
+            raise ArgumentError, 'Required arguments :trigger_ids missing' if options[:trigger_ids].nil?
+            post('workflows.featured.set', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,14 +11,14 @@ module Slack
           #
           # @option options [string] :trigger_id
           #   Encoded ID of the trigger.
+          # @option options [array] :user_ids
+          #   List of encoded user IDs.
           # @option options [array] :channel_ids
           #   List of encoded channel IDs.
-          # @option options [array] :org_ids
-          #   List of encoded organization IDs.
           # @option options [array] :team_ids
           #   List of encoded workspace IDs.
-          # @option options [array] :user_ids
-          #   List of encoded user IDs.
+          # @option options [array] :org_ids
+          #   List of encoded organization IDs.
           # @see https://api.slack.com/methods/workflows.triggers.permissions.add
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/workflows.triggers.permissions/workflows.triggers.permissions.add.json
           def workflows_triggers_permissions_add(options = {})
@@ -43,14 +43,14 @@ module Slack
           #
           # @option options [string] :trigger_id
           #   Encoded ID of the trigger.
+          # @option options [array] :user_ids
+          #   List of encoded user IDs.
           # @option options [array] :channel_ids
           #   List of encoded channel IDs.
-          # @option options [array] :org_ids
-          #   List of encoded organization IDs.
           # @option options [array] :team_ids
           #   List of encoded workspace IDs.
-          # @option options [array] :user_ids
-          #   List of encoded user IDs.
+          # @option options [array] :org_ids
+          #   List of encoded organization IDs.
           # @see https://api.slack.com/methods/workflows.triggers.permissions.remove
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/workflows.triggers.permissions/workflows.triggers.permissions.remove.json
           def workflows_triggers_permissions_remove(options = {})
@@ -61,23 +61,23 @@ module Slack
           #
           # Set the permission type for who can run a trigger
           #
-          # @option options [enum] :permission_type
-          #   The type of permission that defines who can run a trigger.
           # @option options [string] :trigger_id
           #   Encoded ID of the trigger.
+          # @option options [enum] :permission_type
+          #   The type of permission that defines who can run a trigger.
+          # @option options [array] :user_ids
+          #   List of encoded user IDs.
           # @option options [array] :channel_ids
           #   List of encoded channel IDs.
-          # @option options [array] :org_ids
-          #   List of encoded organization IDs.
           # @option options [array] :team_ids
           #   List of encoded workspace IDs.
-          # @option options [array] :user_ids
-          #   List of encoded user IDs.
+          # @option options [array] :org_ids
+          #   List of encoded organization IDs.
           # @see https://api.slack.com/methods/workflows.triggers.permissions.set
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/workflows.triggers.permissions/workflows.triggers.permissions.set.json
           def workflows_triggers_permissions_set(options = {})
-            raise ArgumentError, 'Required arguments :permission_type missing' if options[:permission_type].nil?
             raise ArgumentError, 'Required arguments :trigger_id missing' if options[:trigger_id].nil?
+            raise ArgumentError, 'Required arguments :permission_type missing' if options[:permission_type].nil?
             post('workflows.triggers.permissions.set', options)
           end
         end

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

@@ -77,6 +77,10 @@ require_relative 'endpoints/reactions'
 require_relative 'endpoints/reminders'
 require_relative 'endpoints/rtm'
 require_relative 'endpoints/search'
+require_relative 'endpoints/slackLists'
+require_relative 'endpoints/slackLists_access'
+require_relative 'endpoints/slackLists_download'
+require_relative 'endpoints/slackLists_items'
 require_relative 'endpoints/stars'
 require_relative 'endpoints/team'
 require_relative 'endpoints/team_billing'
@@ -92,7 +96,7 @@ require_relative 'endpoints/users_discoverableContacts'
 require_relative 'endpoints/users_prefs'
 require_relative 'endpoints/users_profile'
 require_relative 'endpoints/views'
-require_relative 'endpoints/workflows'
+require_relative 'endpoints/workflows_featured'
 require_relative 'endpoints/workflows_triggers_permissions'
 
 module Slack
@@ -178,6 +182,10 @@ module Slack
         include Reminders
         include Rtm
         include Search
+        include SlackLists
+        include SlackListsAccess
+        include SlackListsDownload
+        include SlackListsItems
         include Stars
         include Team
         include TeamBilling
@@ -193,7 +201,7 @@ module Slack
         include UsersPrefs
         include UsersProfile
         include Views
-        include Workflows
+        include WorkflowsFeatured
         include WorkflowsTriggersPermissions
       end
     end