slack-ruby-client 0.14.5 → 0.17.0

data/lib/slack/web/api/endpoints/admin_analytics.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 AdminAnalytics
+          #
+          # Retrieve analytics data for a given date, presented as a compressed JSON file
+          #
+          # @option options [Object] :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 [Object] :date
+          #   Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC.
+          # @option options [Object] :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
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.analytics/admin.analytics.getFile.json
+          def admin_analytics_getFile(options = {})
+            throw ArgumentError.new('Required arguments :type missing') if options[:type].nil?
+            post('admin.analytics.getFile', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,25 +11,45 @@ module Slack
           #
           # @option options [Object] :app_id
           #   The id of the app to approve.
+          # @option options [Object] :enterprise_id
+          #   The ID of the enterprise to approve the app on.
           # @option options [Object] :request_id
           #   The id of the request to approve.
           # @option options [Object] :team_id
-          #   .
+          #   The ID of the workspace to approve the app on.
           # @see https://api.slack.com/methods/admin.apps.approve
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.approve.json
           def admin_apps_approve(options = {})
             post('admin.apps.approve', options)
           end
 
+          #
+          # Clear an app resolution
+          #
+          # @option options [Object] :app_id
+          #   The id of the app whose resolution you want to clear/undo.
+          # @option options [Object] :enterprise_id
+          #   The enterprise to clear the app resolution from.
+          # @option options [Object] :team_id
+          #   The workspace to clear the app resolution from.
+          # @see https://api.slack.com/methods/admin.apps.clearResolution
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.clearResolution.json
+          def admin_apps_clearResolution(options = {})
+            throw ArgumentError.new('Required arguments :app_id missing') if options[:app_id].nil?
+            post('admin.apps.clearResolution', options)
+          end
+
           #
           # Restrict an app for installation on a workspace.
           #
           # @option options [Object] :app_id
           #   The id of the app to restrict.
+          # @option options [Object] :enterprise_id
+          #   The ID of the enterprise to approve the app on.
           # @option options [Object] :request_id
           #   The id of the request to restrict.
           # @option options [Object] :team_id
-          #   .
+          #   The ID of the workspace to approve the app on.
           # @see https://api.slack.com/methods/admin.apps.restrict
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.restrict.json
           def admin_apps_restrict(options = {})

data/lib/slack/web/api/endpoints/admin_apps_approved.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 AdminAppsApproved
+          #
+          # List approved apps for an org or 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] :enterprise_id
+          #   .
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [Object] :team_id
+          #   .
+          # @see https://api.slack.com/methods/admin.apps.approved.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.approved/admin.apps.approved.list.json
+          def admin_apps_approved_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_apps_approved_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.apps.approved.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/admin_apps_restricted.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 AdminAppsRestricted
+          #
+          # List restricted apps for an org or 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] :enterprise_id
+          #   .
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [Object] :team_id
+          #   .
+          # @see https://api.slack.com/methods/admin.apps.restricted.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.restricted/admin.apps.restricted.list.json
+          def admin_apps_restricted_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_apps_restricted_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.apps.restricted.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminConversations
+          #
+          # 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
+
+          #
+          # 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.
+          # @option options [Object] :org_channel
+          #   True if channel has to be converted to an org channel.
+          # @option options [Object] :target_team_ids
+          #   A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.
+          # @option options [Object] :team_id
+          #   The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.
+          # @see https://api.slack.com/methods/admin.conversations.setTeams
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.setTeams.json
+          def admin_conversations_setTeams(options = {})
+            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
+  end
+end