slack-ruby-client 0.15.1 → 0.16.0

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminBarriers
+          #
+          # Create an Information Barrier
+          #
+          # @option options [Object] :barriered_from_usergroup_ids
+          #   A list of IDP Groups ids that the primary usergroup is to be barriered from.
+          # @option options [Object] :primary_usergroup_id
+          #   The id of the primary IDP Group.
+          # @option options [Object] :restricted_subjects
+          #   What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.
+          # @see https://api.slack.com/methods/admin.barriers.create
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.barriers/admin.barriers.create.json
+          def admin_barriers_create(options = {})
+            throw ArgumentError.new('Required arguments :barriered_from_usergroup_ids missing') if options[:barriered_from_usergroup_ids].nil?
+            throw ArgumentError.new('Required arguments :primary_usergroup_id missing') if options[:primary_usergroup_id].nil?
+            throw ArgumentError.new('Required arguments :restricted_subjects missing') if options[:restricted_subjects].nil?
+            post('admin.barriers.create', options)
+          end
+
+          #
+          # Delete an existing Information Barrier
+          #
+          # @option options [Object] :barrier_id
+          #   The ID of the barrier you're trying to delete.
+          # @see https://api.slack.com/methods/admin.barriers.delete
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.barriers/admin.barriers.delete.json
+          def admin_barriers_delete(options = {})
+            throw ArgumentError.new('Required arguments :barrier_id missing') if options[:barrier_id].nil?
+            post('admin.barriers.delete', options)
+          end
+
+          #
+          # Get all Information Barriers for your organization
+          #
+          # @option options [Object] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @see https://api.slack.com/methods/admin.barriers.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.barriers/admin.barriers.list.json
+          def admin_barriers_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_barriers_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.barriers.list', options)
+            end
+          end
+
+          #
+          # Update an existing Information Barrier
+          #
+          # @option options [Object] :barrier_id
+          #   The ID of the barrier you're trying to modify.
+          # @option options [Object] :barriered_from_usergroup_ids
+          #   A list of IDP Groups ids that the primary usergroup is to be barriered from.
+          # @option options [Object] :primary_usergroup_id
+          #   The id of the primary IDP Group.
+          # @option options [Object] :restricted_subjects
+          #   What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.
+          # @see https://api.slack.com/methods/admin.barriers.update
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.barriers/admin.barriers.update.json
+          def admin_barriers_update(options = {})
+            throw ArgumentError.new('Required arguments :barrier_id missing') if options[:barrier_id].nil?
+            throw ArgumentError.new('Required arguments :barriered_from_usergroup_ids missing') if options[:barriered_from_usergroup_ids].nil?
+            throw ArgumentError.new('Required arguments :primary_usergroup_id missing') if options[:primary_usergroup_id].nil?
+            throw ArgumentError.new('Required arguments :restricted_subjects missing') if options[:restricted_subjects].nil?
+            post('admin.barriers.update', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,225 @@ module Slack
       module Endpoints
         module AdminConversations
           #
-          # Set the workspaces in an Enterprise grid org that connect to a channel.
+          # Archive a public or private channel.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to archive.
+          # @see https://api.slack.com/methods/admin.conversations.archive
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.archive.json
+          def admin_conversations_archive(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            post('admin.conversations.archive', options)
+          end
+
+          #
+          # Convert a public channel to a private channel.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to convert to private.
+          # @see https://api.slack.com/methods/admin.conversations.convertToPrivate
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.convertToPrivate.json
+          def admin_conversations_convertToPrivate(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            post('admin.conversations.convertToPrivate', options)
+          end
+
+          #
+          # Create a public or private channel-based conversation.
+          #
+          # @option options [Object] :is_private
+          #   When true, creates a private channel instead of a public channel.
+          # @option options [Object] :name
+          #   Name of the public or private channel to create.
+          # @option options [Object] :description
+          #   Description of the public or private channel to create.
+          # @option options [Object] :org_wide
+          #   When true, the channel will be available org-wide. Note: if the channel is not org_wide=true, you must specify a team_id for this channel.
+          # @option options [Object] :team_id
+          #   The workspace to create the channel in. Note: this argument is required unless you set org_wide=true.
+          # @see https://api.slack.com/methods/admin.conversations.create
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.create.json
+          def admin_conversations_create(options = {})
+            throw ArgumentError.new('Required arguments :is_private missing') if options[:is_private].nil?
+            throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            post('admin.conversations.create', options)
+          end
+
+          #
+          # Delete a public or private channel.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to delete.
+          # @see https://api.slack.com/methods/admin.conversations.delete
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.delete.json
+          def admin_conversations_delete(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            post('admin.conversations.delete', options)
+          end
+
+          #
+          # Disconnect a connected channel from one or more workspaces.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to be disconnected from some workspaces.
+          # @option options [Object] :leaving_team_ids
+          #   The team to be removed from the channel. Currently only a single team id can be specified.
+          # @see https://api.slack.com/methods/admin.conversations.disconnectShared
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.disconnectShared.json
+          def admin_conversations_disconnectShared(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            post('admin.conversations.disconnectShared', options)
+          end
+
+          #
+          # Get conversation preferences for a public or private channel.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to get preferences for.
+          # @see https://api.slack.com/methods/admin.conversations.getConversationPrefs
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.getConversationPrefs.json
+          def admin_conversations_getConversationPrefs(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            post('admin.conversations.getConversationPrefs', options)
+          end
+
+          #
+          # This API endpoint can be used by any admin to get a channel's retention policy.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to get the retention policy for.
+          # @see https://api.slack.com/methods/admin.conversations.getCustomRetention
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.getCustomRetention.json
+          def admin_conversations_getCustomRetention(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            post('admin.conversations.getCustomRetention', options)
+          end
+
+          #
+          # Get all the workspaces a given public or private channel is connected to within this Enterprise org.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to determine connected workspaces within the organization for.
+          # @option options [Object] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @see https://api.slack.com/methods/admin.conversations.getTeams
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.getTeams.json
+          def admin_conversations_getTeams(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            if block_given?
+              Pagination::Cursor.new(self, :admin_conversations_getTeams, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.conversations.getTeams', options)
+            end
+          end
+
+          #
+          # Invite a user to a public or private channel.
+          #
+          # @option options [Object] :channel_id
+          #   The channel that the users will be invited to.
+          # @option options [Object] :user_ids
+          #   The users to invite.
+          # @see https://api.slack.com/methods/admin.conversations.invite
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.invite.json
+          def admin_conversations_invite(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            throw ArgumentError.new('Required arguments :user_ids missing') if options[:user_ids].nil?
+            post('admin.conversations.invite', options)
+          end
+
+          #
+          # This API endpoint can be used by any admin to remove a channel's retention policy.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to set the retention policy for.
+          # @see https://api.slack.com/methods/admin.conversations.removeCustomRetention
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.removeCustomRetention.json
+          def admin_conversations_removeCustomRetention(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            post('admin.conversations.removeCustomRetention', options)
+          end
+
+          #
+          # Rename a public or private channel.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to rename.
+          # @option options [Object] :name
+          #   .
+          # @see https://api.slack.com/methods/admin.conversations.rename
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.rename.json
+          def admin_conversations_rename(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            post('admin.conversations.rename', options)
+          end
+
+          #
+          # Search for public or private channels in an Enterprise organization.
+          #
+          # @option options [Object] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :limit
+          #   Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.
+          # @option options [Object] :query
+          #   Name of the the channel to query by.
+          # @option options [Object] :search_channel_types
+          #   The type of channel to include or exclude in the search. For example private will search private channels, while private_exclude will exclude them. For a full list of types, check the Types section.
+          # @option options [Object] :sort
+          #   Possible values are relevant (search ranking based on what we think is closest), name (alphabetical), member_count (number of users in the channel), and created (date channel was created). You can optionally pair this with the sort_dir arg to change how it is sorted.
+          # @option options [Object] :sort_dir
+          #   Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a).
+          # @option options [Object] :team_ids
+          #   Comma separated string of team IDs, signifying the workspaces to search through.
+          # @see https://api.slack.com/methods/admin.conversations.search
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.search.json
+          def admin_conversations_search(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_conversations_search, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.conversations.search', options)
+            end
+          end
+
+          #
+          # Set the posting permissions for a public or private channel.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to set the prefs for.
+          # @option options [Object] :prefs
+          #   The prefs for this channel in a stringified JSON format.
+          # @see https://api.slack.com/methods/admin.conversations.setConversationPrefs
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.setConversationPrefs.json
+          def admin_conversations_setConversationPrefs(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            throw ArgumentError.new('Required arguments :prefs missing') if options[:prefs].nil?
+            post('admin.conversations.setConversationPrefs', options)
+          end
+
+          #
+          # This API endpoint can be used by any admin to set a channel's retention policy.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to set the retention policy for.
+          # @option options [Object] :duration_days
+          #   The message retention duration in days to set for this channel.
+          # @see https://api.slack.com/methods/admin.conversations.setCustomRetention
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.setCustomRetention.json
+          def admin_conversations_setCustomRetention(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            throw ArgumentError.new('Required arguments :duration_days missing') if options[:duration_days].nil?
+            post('admin.conversations.setCustomRetention', options)
+          end
+
+          #
+          # Set the workspaces in an Enterprise grid org that connect to a public or private channel.
           #
           # @option options [Object] :channel_id
           #   The encoded channel_id to add or remove to workspaces.
@@ -23,6 +241,18 @@ module Slack
             throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
             post('admin.conversations.setTeams', options)
           end
+
+          #
+          # Unarchive a public or private channel.
+          #
+          # @option options [Object] :channel_id
+          #   The channel to unarchive.
+          # @see https://api.slack.com/methods/admin.conversations.unarchive
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.unarchive.json
+          def admin_conversations_unarchive(options = {})
+            throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
+            post('admin.conversations.unarchive', options)
+          end
         end
       end
     end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminConversationsEkm
+          #
+          # List all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM.
+          #
+          # @option options [Object] :channel_ids
+          #   A comma-separated list of channels to filter to.
+          # @option options [Object] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [Object] :team_ids
+          #   A comma-separated list of the workspaces to which the channels you would like returned belong.
+          # @see https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.ekm/admin.conversations.ekm.listOriginalConnectedChannelInfo.json
+          def admin_conversations_ekm_listOriginalConnectedChannelInfo(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_conversations_ekm_listOriginalConnectedChannelInfo, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.conversations.ekm.listOriginalConnectedChannelInfo', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,7 +14,7 @@ module Slack
           # @option options [Object] :group_id
           #   The IDP Group ID to be an allowlist for the private channel.
           # @option options [Object] :team_id
-          #   The workspace where the IDP Group and channel exist.
+          #   The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
           # @see https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.restrictAccess/admin.conversations.restrictAccess.addGroup.json
           def admin_conversations_restrictAccess_addGroup(options = {})
@@ -29,7 +29,7 @@ module Slack
           # @option options [Object] :channel_id
           #   .
           # @option options [Object] :team_id
-          #   The workspace where the channele exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
+          #   The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
           # @see https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.restrictAccess/admin.conversations.restrictAccess.listGroups.json
           def admin_conversations_restrictAccess_listGroups(options = {})
@@ -45,7 +45,7 @@ module Slack
           # @option options [Object] :group_id
           #   The IDP Group ID to remove from the private channel.
           # @option options [Object] :team_id
-          #   The workspace where the IDP Group and channel exist.
+          #   The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
           # @see https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.restrictAccess/admin.conversations.restrictAccess.removeGroup.json
           def admin_conversations_restrictAccess_removeGroup(options = {})

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

@@ -20,7 +20,7 @@ module Slack
           def admin_conversations_whitelist_add(options = {})
             throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
             throw ArgumentError.new('Required arguments :group_id missing') if options[:group_id].nil?
-            logger.warn('admin.conversations.whitelist.add:  Alternative methods: .')
+            logger.warn('admin.conversations.whitelist.add: This method is deprecated Alternative methods: .')
             post('admin.conversations.whitelist.add', options)
           end
 
@@ -35,7 +35,7 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.whitelist/admin.conversations.whitelist.listGroupsLinkedToChannel.json
           def admin_conversations_whitelist_listGroupsLinkedToChannel(options = {})
             throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
-            logger.warn('admin.conversations.whitelist.listGroupsLinkedToChannel:  Alternative methods: .')
+            logger.warn('admin.conversations.whitelist.listGroupsLinkedToChannel: This method is deprecated Alternative methods: .')
             post('admin.conversations.whitelist.listGroupsLinkedToChannel', options)
           end
 
@@ -54,7 +54,7 @@ module Slack
             throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
             throw ArgumentError.new('Required arguments :group_id missing') if options[:group_id].nil?
             throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
-            logger.warn('admin.conversations.whitelist.remove:  Alternative methods: .')
+            logger.warn('admin.conversations.whitelist.remove: This method is deprecated Alternative methods: .')
             post('admin.conversations.whitelist.remove', options)
           end
         end

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

@@ -10,7 +10,7 @@ module Slack
           # Add an emoji.
           #
           # @option options [Object] :name
-          #   The name of the emoji to be removed. Colons (:myemoji:) around the value are not required, although they may be included.
+          #   The name of the emoji to be added. Colons (:myemoji:) around the value are not required, although they may be included.
           # @option options [Object] :url
           #   The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best.
           # @see https://api.slack.com/methods/admin.emoji.add

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

@@ -7,7 +7,7 @@ module Slack
       module Endpoints
         module AdminUsergroups
           #
-          # Add one or more default channels to an IDP group.
+          # Add up to one hundred default channels to an IDP group.
           #
           # @option options [Object] :channel_ids
           #   Comma separated string of channel IDs.

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

@@ -60,16 +60,15 @@ module Slack
           #
           # List users on a workspace
           #
-          # @option options [Object] :team_id
-          #   The ID (T1234) of the workspace.
           # @option options [Object] :cursor
           #   Set cursor to next_cursor returned by the previous call to list items in the next page.
           # @option options [Object] :limit
           #   Limit for how many users to be retrieved per page.
+          # @option options [Object] :team_id
+          #   The ID (T1234) of the workspace.
           # @see https://api.slack.com/methods/admin.users.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.list.json
           def admin_users_list(options = {})
-            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
             if block_given?
               Pagination::Cursor.new(self, :admin_users_list, options).each do |page|
                 yield page
@@ -114,15 +113,14 @@ module Slack
           #
           # @option options [Object] :expiration_ts
           #   Timestamp when guest account should be disabled.
-          # @option options [Object] :team_id
-          #   The ID (T1234) of the workspace.
           # @option options [Object] :user_id
           #   The ID of the user to set an expiration for.
+          # @option options [Object] :team_id
+          #   The ID (T1234) of the workspace.
           # @see https://api.slack.com/methods/admin.users.setExpiration
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setExpiration.json
           def admin_users_setExpiration(options = {})
             throw ArgumentError.new('Required arguments :expiration_ts missing') if options[:expiration_ts].nil?
-            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
             throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
             post('admin.users.setExpiration', options)
           end