slack-ruby-client 2.0.0 → 2.1.0

data/bin/slack

@@ -2,50 +2,55 @@
 require 'gli'
 require 'slack_ruby_client'
 
-include GLI::App
-
-program_desc 'Slack client.'
-
-default_command :help
-
-switch %i[d debug], desc: 'Enable debug-level logging.', default_value: false
-flag [:t, 'slack-api-token'], desc: 'Slack API token.', default_value: ENV['SLACK_API_TOKEN']
-flag ['vcr-cassette-name'], desc: 'Offline VCR cassette.'
-
-pre do |global_options, _command, options, _args|
-  # global Slack configuration
-  Slack.config.token = global_options['slack-api-token']
-  help_now! 'Set Slack API token via --slack-api-token or SLACK_API_TOKEN.' unless Slack.config.token && !Slack.config.token.empty?
-
-  if global_options['debug']
-    require 'logger'
-    logger = Logger.new(STDOUT)
-    logger.level = Logger::DEBUG
-    Slack::Web::Client.config.logger = logger
-  end
-
-  $client = Slack::Web::Client.new
-
-  # Offline VCR cassette
-  if global_options['vcr-cassette-name']
-    require 'webmock'
-    WebMock.enable!
-    require 'vcr'
-    VCR.configure do |config|
-      config.cassette_library_dir = 'spec/fixtures/slack'
-      config.hook_into :webmock
-      config.default_cassette_options = { record: :new_episodes }
+module Slack
+  module Cli
+    class App
+      extend GLI::App
+
+      program_desc 'Slack client.'
+
+      default_command :help
+
+      switch %i[d debug], desc: 'Enable debug-level logging.', default_value: false
+      flag [:t, 'slack-api-token'], desc: 'Slack API token.', default_value: ENV['SLACK_API_TOKEN']
+      flag ['vcr-cassette-name'], desc: 'Offline VCR cassette.'
+
+      commands_from File.expand_path('commands', __dir__)
+
+      pre do |global_options, _command, options, _args|
+        # global Slack configuration
+        Slack.config.token = global_options['slack-api-token']
+        help_now! 'Set Slack API token via --slack-api-token or SLACK_API_TOKEN.' unless Slack.config.token && !Slack.config.token.empty?
+
+        if global_options['debug']
+          require 'logger'
+          logger = Logger.new(STDOUT)
+          logger.level = Logger::DEBUG
+          Slack::Web::Client.config.logger = logger
+        end
+
+        @client = Slack::Web::Client.new
+
+        # Offline VCR cassette
+        if global_options['vcr-cassette-name']
+          require 'webmock'
+          WebMock.enable!
+          require 'vcr'
+          VCR.configure do |config|
+            config.cassette_library_dir = 'spec/fixtures/slack'
+            config.hook_into :webmock
+            config.default_cassette_options = { record: :new_episodes }
+          end
+          VCR.insert_cassette global_options['vcr-cassette-name']
+        end
+
+        # remove any nil values from options
+        options.compact!
+
+        true
+      end
     end
-    VCR.insert_cassette global_options['vcr-cassette-name']
   end
-
-  # remove any nil values from options
-  options.compact!
-
-  true
 end
 
-$LOAD_PATH.push File.expand_path(__dir__)
-require 'commands'
-
-exit run(ARGV)
+exit Slack::Cli::App.run(ARGV)

data/lib/slack/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Slack
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

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

@@ -12,7 +12,7 @@ module Slack
           # @option options [string] :type
           #   The type of analytics to retrieve. The options are currently limited to member (for grid member analytics) and public_channel (for public channel analytics).
           # @option options [date] :date
-          #   Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC.
+          #   Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC. Required unless metadata_only is set to true.
           # @option options [boolean] :metadata_only
           #   Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.
           # @see https://api.slack.com/methods/admin.analytics.getFile

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

@@ -7,7 +7,7 @@ module Slack
       module Endpoints
         module AdminAppsRequests
           #
-          # Cancel approval request for team
+          # Cancel app request for team
           #
           # @option options [string] :request_id
           #   The id of the request to cancel.

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

@@ -18,6 +18,45 @@ module Slack
             post('admin.conversations.archive', options)
           end
 
+          #
+          # Archive public or private channels in bulk.
+          #
+          # @option options [array] :channel_ids
+          #   An array of channel IDs to archive.
+          # @see https://api.slack.com/methods/admin.conversations.bulkArchive
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.bulkArchive.json
+          def admin_conversations_bulkArchive(options = {})
+            raise ArgumentError, 'Required arguments :channel_ids missing' if options[:channel_ids].nil?
+            post('admin.conversations.bulkArchive', options)
+          end
+
+          #
+          # Delete public or private channels in bulk
+          #
+          # @option options [array] :channel_ids
+          #   An array of channel IDs.
+          # @see https://api.slack.com/methods/admin.conversations.bulkDelete
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.bulkDelete.json
+          def admin_conversations_bulkDelete(options = {})
+            raise ArgumentError, 'Required arguments :channel_ids missing' if options[:channel_ids].nil?
+            post('admin.conversations.bulkDelete', options)
+          end
+
+          #
+          # Move public or private channels in bulk.
+          #
+          # @option options [array] :channel_ids
+          #   An array of channel IDs.
+          # @option options [string] :target_team_id
+          #   Target team ID.
+          # @see https://api.slack.com/methods/admin.conversations.bulkMove
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.bulkMove.json
+          def admin_conversations_bulkMove(options = {})
+            raise ArgumentError, 'Required arguments :channel_ids missing' if options[:channel_ids].nil?
+            raise ArgumentError, 'Required arguments :target_team_id missing' if options[:target_team_id].nil?
+            post('admin.conversations.bulkMove', options)
+          end
+
           #
           # Convert a public channel to a private channel.
           #
@@ -32,6 +71,18 @@ module Slack
             post('admin.conversations.convertToPrivate', options)
           end
 
+          #
+          # Convert a private channel to a public channel.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to convert to public.
+          # @see https://api.slack.com/methods/admin.conversations.convertToPublic
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.convertToPublic.json
+          def admin_conversations_convertToPublic(options = {})
+            raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
+            post('admin.conversations.convertToPublic', options)
+          end
+
           #
           # Create a public or private channel-based conversation.
           #
@@ -140,6 +191,33 @@ module Slack
             post('admin.conversations.invite', options)
           end
 
+          #
+          # Returns channels on the given team using the filters.
+          #
+          # @option options [integer] :last_message_activity_before
+          #   Filter by public channels where the most recent message was sent before last_message_activity.
+          # @option options [array] :team_ids
+          #   Array of team IDs to filter by.
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned in the previous call, to fetch the next page.
+          # @option options [integer] :limit
+          #   Maximum number of results.
+          # @option options [integer] :max_member_count
+          #   Filter by public channels with member count equal to or less than the specified number.
+          # @see https://api.slack.com/methods/admin.conversations.lookup
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.lookup.json
+          def admin_conversations_lookup(options = {})
+            raise ArgumentError, 'Required arguments :last_message_activity_before missing' if options[:last_message_activity_before].nil?
+            raise ArgumentError, 'Required arguments :team_ids missing' if options[:team_ids].nil?
+            if block_given?
+              Pagination::Cursor.new(self, :admin_conversations_lookup, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.conversations.lookup', options)
+            end
+          end
+
           #
           # This API endpoint can be used by any admin to remove a conversation's retention policy.
           #

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminRoles
+          #
+          # Adds members to the specified role with the specified scopes
+          #
+          # @option options [array] :entity_ids
+          #   List of the entity IDs for which roles will be assigned. These can be Org IDs, Team IDs or Channel IDs.
+          # @option options [string] :role_id
+          #   ID of the role to which users will be assigned.
+          # @option options [array] :user_ids
+          #   List of IDs from the users to be added to the given role.
+          # @see https://api.slack.com/methods/admin.roles.addAssignments
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.roles/admin.roles.addAssignments.json
+          def admin_roles_addAssignments(options = {})
+            raise ArgumentError, 'Required arguments :entity_ids missing' if options[:entity_ids].nil?
+            raise ArgumentError, 'Required arguments :role_id missing' if options[:role_id].nil?
+            raise ArgumentError, 'Required arguments :user_ids missing' if options[:user_ids].nil?
+            post('admin.roles.addAssignments', options)
+          end
+
+          #
+          # Lists assignments for all roles across entities. Options to scope results by any combination of roles or entities
+          #
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [array] :entity_ids
+          #   The entities for which the roles apply.
+          # @option options [integer] :limit
+          #   The maximum number of items to return. Must be between 1 - 100 both inclusive.
+          # @option options [array] :role_ids
+          #   collection of role ids to scope results by.
+          # @option options [string] :sort_dir
+          #   Sort direction. Default is descending on date_create, can be either ASC or DESC.
+          # @see https://api.slack.com/methods/admin.roles.listAssignments
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.roles/admin.roles.listAssignments.json
+          def admin_roles_listAssignments(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_roles_listAssignments, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.roles.listAssignments', options)
+            end
+          end
+
+          #
+          # Removes a set of users from a role for the given scopes and entities
+          #
+          # @option options [array] :entity_ids
+          #   List of the entity IDs for which roles will be revoked. These can be Org IDs, Team IDs or Channel IDs.
+          # @option options [string] :role_id
+          #   ID of the role to which users will be assigned.
+          # @option options [array] :user_ids
+          #   List of IDs of the users whose roles will be revoked.
+          # @see https://api.slack.com/methods/admin.roles.removeAssignments
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.roles/admin.roles.removeAssignments.json
+          def admin_roles_removeAssignments(options = {})
+            raise ArgumentError, 'Required arguments :entity_ids missing' if options[:entity_ids].nil?
+            raise ArgumentError, 'Required arguments :role_id missing' if options[:role_id].nil?
+            raise ArgumentError, 'Required arguments :user_ids missing' if options[:user_ids].nil?
+            post('admin.roles.removeAssignments', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -101,7 +101,7 @@ module Slack
           # @option options [user] :user
           #   id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.
           # @option options [boolean] :as_user
-          #   Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.
+          #   (Legacy) Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.
           # @option options [string] :attachments
           #   A JSON-based array of structured attachments, presented as a URL-encoded string.
           # @option options [blocks[] as string] :blocks
@@ -152,7 +152,7 @@ module Slack
           # @option options [string] :text
           #   The formatted text of the message to be published. If blocks are included, this will become the fallback text used in notifications.
           # @option options [boolean] :as_user
-          #   Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See authorship below.
+          #   (Legacy) Pass true to post the message as the authed user instead of as a bot. Defaults to false. Can only be used by classic Slack apps. See authorship below.
           # @option options [string] :icon_emoji
           #   Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
           # @option options [string] :icon_url

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

@@ -19,7 +19,7 @@ module Slack
           #   See the shared_channel_invite_received event payload for more details on how to retrieve the ID of the invitation.
           # @option options [boolean] :is_private
           #   Whether the channel should be private.
-          # @option options [string] :team_id
+          # @option options [Object] :team_id
           #   The ID of the workspace to accept the channel in. If an org-level token is used to call this method, the team_id argument is required.
           # @see https://api.slack.com/methods/conversations.acceptSharedInvite
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.acceptSharedInvite.json

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

@@ -9,6 +9,8 @@ module Slack
           #
           # Lists custom emoji for a team.
           #
+          # @option options [boolean] :include_categories
+          #   Include a list of categories for Unicode emoji and the emoji in each category.
           # @see https://api.slack.com/methods/emoji.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/emoji/emoji.list.json
           def emoji_list(options = {})

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

@@ -99,8 +99,6 @@ module Slack
           #
           # @option options [channel] :channel
           #   Filter files appearing in a specific channel, indicated by its ID.
-          # @option options [string] :files
-          #   .
           # @option options [boolean] :show_files_hidden_by_limit
           #   Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.
           # @option options [string] :team_id

data/lib/slack/web/api/endpoints/functions_workflows_steps.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 FunctionsWorkflowsSteps
+          #
+          # List the steps of a specific function of a workflow's versions
+          #
+          # @option options [string] :function_id
+          #   .
+          # @option options [string] :workflow
+          #   The workflow encoded ID or workflow reference.
+          # @option options [string] :workflow_id
+          #   The workflow ID, starts with Wf*.
+          # @see https://api.slack.com/methods/functions.workflows.steps.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/functions.workflows.steps/functions.workflows.steps.list.json
+          def functions_workflows_steps_list(options = {})
+            raise ArgumentError, 'Required arguments :function_id missing' if options[:function_id].nil?
+            post('functions.workflows.steps.list', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/functions_workflows_steps_responses.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 FunctionsWorkflowsStepsResponses
+          #
+          # Download form responses of a workflow
+          #
+          # @option options [string] :step_id
+          #   .
+          # @option options [string] :workflow
+          #   The workflow encoded ID or workflow reference.
+          # @option options [string] :workflow_id
+          #   The workflow ID, starts with Wf*.
+          # @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 = {})
+            raise ArgumentError, 'Required arguments :step_id missing' if options[:step_id].nil?
+            post('functions.workflows.steps.responses.export', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,6 +11,8 @@ module Slack
           #
           # @option options [channel] :channel
           #   Channel to pin the messsage to. You must also include a timestamp when pinning messages.
+          # @option options [string] :quip_component_id
+          #   Component ID for the pins component that was inserted into the channel canvas, if any.
           # @option options [string] :timestamp
           #   Timestamp of the message to pin. You must also include the channel.
           # @see https://api.slack.com/methods/pins.add

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

@@ -22,6 +22,10 @@ module Slack
           #
           # Gets billable users information for the current team.
           #
+          # @option options [string] :cursor
+          #   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
@@ -30,7 +34,13 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/team/team.billableInfo.json
           def team_billableInfo(options = {})
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
-            post('team.billableInfo', options)
+            if block_given?
+              Pagination::Cursor.new(self, :team_billableInfo, options).each do |page|
+                yield page
+              end
+            else
+              post('team.billableInfo', options)
+            end
           end
 
           #

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

@@ -36,7 +36,7 @@ module Slack
           # @option options [boolean] :include_count
           #   Include the number of users in the User Group.
           # @option options [Object] :team_id
-          #   Encoded team id where the user group is, required if org token is used.
+          #   Encoded target team id where the user group is, required if org token is used.
           # @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 = {})

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

@@ -28,7 +28,7 @@ module Slack
           # @option options [string] :profile
           #   Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.
           # @option options [user] :user
-          #   ID of user to change. This argument may only be specified by team admins on paid teams.
+          #   ID of user to change. This argument may only be specified by admins on paid teams.
           # @option options [string] :value
           #   Value to set a single key to. Usable only if profile is not passed.
           # @see https://api.slack.com/methods/users.profile.set

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

@@ -16,6 +16,7 @@ require_relative 'endpoints/admin_emoji'
 require_relative 'endpoints/admin_inviteRequests'
 require_relative 'endpoints/admin_inviteRequests_approved'
 require_relative 'endpoints/admin_inviteRequests_denied'
+require_relative 'endpoints/admin_roles'
 require_relative 'endpoints/admin_teams'
 require_relative 'endpoints/admin_teams_admins'
 require_relative 'endpoints/admin_teams_owners'
@@ -44,6 +45,8 @@ require_relative 'endpoints/emoji'
 require_relative 'endpoints/files'
 require_relative 'endpoints/files_comments'
 require_relative 'endpoints/files_remote'
+require_relative 'endpoints/functions_workflows_steps'
+require_relative 'endpoints/functions_workflows_steps_responses'
 require_relative 'endpoints/migration'
 require_relative 'endpoints/oauth'
 require_relative 'endpoints/oauth_v2'
@@ -90,6 +93,7 @@ module Slack
         include AdminInviterequests
         include AdminInviterequestsApproved
         include AdminInviterequestsDenied
+        include AdminRoles
         include AdminTeams
         include AdminTeamsAdmins
         include AdminTeamsOwners
@@ -118,6 +122,8 @@ module Slack
         include Files
         include FilesComments
         include FilesRemote
+        include FunctionsWorkflowsSteps
+        include FunctionsWorkflowsStepsResponses
         include Migration
         include Oauth
         include OauthV2