slack-ruby-client 0.14.5 → 0.17.0

data/UPGRADING.md

@@ -1,6 +1,26 @@
 Upgrading Slack-Ruby-Client
 ===========================
 
+### Upgrading to >= 0.16.0
+
+#### Removed Celluloid and Faye-Websocket Concurrency Support
+
+Concurrency support for `celluloid-io` and `faye-websocket` has been removed. If you are running a RealTime bot on Celluloid or Faye, you must upgrade to `async-websocket`. Please note that RealTime bots are deprecated by Slack, and we generally recommend you [migrate your classic, RealTime bot, to granular permissions](https://code.dblock.org/2020/11/30/migrating-classic-slack-ruby-bots-to-granular-permissions.html).
+
+See [#338](https://github.com/slack-ruby/slack-ruby-client/issues/338) for more information.
+
+#### Error Handling
+
+As of 0.16.0 `Faraday::Error` exceptions sans `Faraday::ClientError` are wrapped into `Slack::Web::Api::Errors::ServerError`, so if you're rescuing `Faraday::Error` — you should adjust your code to use `Slack::Web::Api::Errors::ServerError` and use `exception.cause` if underlying `Faraday::Error` is needed.
+
+See [README#other-errors](README.md#other-errors) and [#350](https://github.com/slack-ruby/slack-ruby-client/pull/350) for more information.
+
+### Upgrading to >= 0.15.0
+
+As of 0.15.0, `activesupport` is no longer required. Add `gem 'activesupport'` to your Gemfile if you required ActiveSupport via this library.
+
+See [#325](https://github.com/slack-ruby/slack-ruby-client/pull/325) for more information.
+
 ### Upgrading to >= 0.14.0
 
 If you are using async-websocket, lock down its version to 0.8.0 as newer versions are currently incompatible.
@@ -124,5 +144,3 @@ gem 'celluloid-io'
 When in doubt, use `faye-websocket`.
 
 See [#5](https://github.com/slack-ruby/slack-ruby-client/issues/5) for more information.
-
-

data/bin/commands.rb

@@ -1,17 +1,39 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
+require 'commands/admin_analytics'
 require 'commands/admin_apps'
+require 'commands/admin_apps_approved'
 require 'commands/admin_apps_requests'
+require 'commands/admin_apps_restricted'
+require 'commands/admin_barriers'
+require 'commands/admin_conversations'
+require 'commands/admin_conversations_ekm'
+require 'commands/admin_conversations_restrictAccess'
+require 'commands/admin_emoji'
+require 'commands/admin_inviteRequests'
+require 'commands/admin_inviteRequests_approved'
+require 'commands/admin_inviteRequests_denied'
+require 'commands/admin_teams'
+require 'commands/admin_teams_admins'
+require 'commands/admin_teams_owners'
+require 'commands/admin_teams_settings'
+require 'commands/admin_usergroups'
+require 'commands/admin_users'
 require 'commands/admin_users_session'
 require 'commands/api'
 require 'commands/apps'
+require 'commands/apps_connections'
+require 'commands/apps_event_authorizations'
 require 'commands/apps_permissions'
 require 'commands/apps_permissions_resources'
 require 'commands/apps_permissions_scopes'
 require 'commands/apps_permissions_users'
 require 'commands/auth'
+require 'commands/auth_teams'
 require 'commands/bots'
+require 'commands/calls'
+require 'commands/calls_participants'
 require 'commands/channels'
 require 'commands/chat'
 require 'commands/chat_scheduledMessages'
@@ -43,3 +65,4 @@ require 'commands/users_admin'
 require 'commands/users_prefs'
 require 'commands/users_profile'
 require 'commands/views'
+require 'commands/workflows'

data/bin/commands/admin_analytics.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminAnalytics methods.'
+command 'admin_analytics' do |g|
+  g.desc 'Retrieve analytics data for a given date, presented as a compressed JSON file'
+  g.long_desc %( Retrieve analytics data for a given date, presented as a compressed JSON file )
+  g.command 'getFile' do |c|
+    c.flag 'type', desc: 'The type of analytics to retrieve. The options are currently limited to member (for grid member analytics) and public_channel (for public channel analytics).'
+    c.flag 'date', desc: 'Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC.'
+    c.flag 'metadata_only', desc: '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.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_analytics_getFile(options))
+    end
+  end
+end

data/bin/commands/admin_apps.rb

@@ -7,19 +7,32 @@ command 'admin_apps' do |g|
   g.long_desc %( Approve an app for installation on a workspace. )
   g.command 'approve' do |c|
     c.flag 'app_id', desc: 'The id of the app to approve.'
+    c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
     c.flag 'request_id', desc: 'The id of the request to approve.'
-    c.flag 'team_id', desc: '.'
+    c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.admin_apps_approve(options))
     end
   end
 
+  g.desc 'Clear an app resolution'
+  g.long_desc %( Clear an app resolution )
+  g.command 'clearResolution' do |c|
+    c.flag 'app_id', desc: 'The id of the app whose resolution you want to clear/undo.'
+    c.flag 'enterprise_id', desc: 'The enterprise to clear the app resolution from.'
+    c.flag 'team_id', desc: 'The workspace to clear the app resolution from.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_apps_clearResolution(options))
+    end
+  end
+
   g.desc 'Restrict an app for installation on a workspace.'
   g.long_desc %( Restrict an app for installation on a workspace. )
   g.command 'restrict' do |c|
     c.flag 'app_id', desc: 'The id of the app to restrict.'
+    c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
     c.flag 'request_id', desc: 'The id of the request to restrict.'
-    c.flag 'team_id', desc: '.'
+    c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.admin_apps_restrict(options))
     end

data/bin/commands/admin_apps_approved.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminAppsApproved methods.'
+command 'admin_apps_approved' do |g|
+  g.desc 'List approved apps for an org or workspace.'
+  g.long_desc %( List approved apps for an org or workspace. )
+  g.command 'list' do |c|
+    c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
+    c.flag 'enterprise_id', desc: '.'
+    c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
+    c.flag 'team_id', desc: '.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_apps_approved_list(options))
+    end
+  end
+end

data/bin/commands/admin_apps_restricted.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminAppsRestricted methods.'
+command 'admin_apps_restricted' do |g|
+  g.desc 'List restricted apps for an org or workspace.'
+  g.long_desc %( List restricted apps for an org or workspace. )
+  g.command 'list' do |c|
+    c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
+    c.flag 'enterprise_id', desc: '.'
+    c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
+    c.flag 'team_id', desc: '.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_apps_restricted_list(options))
+    end
+  end
+end

data/bin/commands/admin_barriers.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminBarriers methods.'
+command 'admin_barriers' do |g|
+  g.desc 'Create an Information Barrier'
+  g.long_desc %( Create an Information Barrier )
+  g.command 'create' do |c|
+    c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
+    c.flag 'primary_usergroup_id', desc: 'The id of the primary IDP Group.'
+    c.flag 'restricted_subjects', desc: 'What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_barriers_create(options))
+    end
+  end
+
+  g.desc 'Delete an existing Information Barrier'
+  g.long_desc %( Delete an existing Information Barrier )
+  g.command 'delete' do |c|
+    c.flag 'barrier_id', desc: "The ID of the barrier you're trying to delete."
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_barriers_delete(options))
+    end
+  end
+
+  g.desc 'Get all Information Barriers for your organization'
+  g.long_desc %( Get all Information Barriers for your organization )
+  g.command 'list' do |c|
+    c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
+    c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_barriers_list(options))
+    end
+  end
+
+  g.desc 'Update an existing Information Barrier'
+  g.long_desc %( Update an existing Information Barrier )
+  g.command 'update' do |c|
+    c.flag 'barrier_id', desc: "The ID of the barrier you're trying to modify."
+    c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
+    c.flag 'primary_usergroup_id', desc: 'The id of the primary IDP Group.'
+    c.flag 'restricted_subjects', desc: 'What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_barriers_update(options))
+    end
+  end
+end

data/bin/commands/admin_conversations.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminConversations methods.'
+command 'admin_conversations' do |g|
+  g.desc 'Archive a public or private channel.'
+  g.long_desc %( Archive a public or private channel. )
+  g.command 'archive' do |c|
+    c.flag 'channel_id', desc: 'The channel to archive.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_archive(options))
+    end
+  end
+
+  g.desc 'Convert a public channel to a private channel.'
+  g.long_desc %( Convert a public channel to a private channel. )
+  g.command 'convertToPrivate' do |c|
+    c.flag 'channel_id', desc: 'The channel to convert to private.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_convertToPrivate(options))
+    end
+  end
+
+  g.desc 'Create a public or private channel-based conversation.'
+  g.long_desc %( Create a public or private channel-based conversation. )
+  g.command 'create' do |c|
+    c.flag 'is_private', desc: 'When true, creates a private channel instead of a public channel.'
+    c.flag 'name', desc: 'Name of the public or private channel to create.'
+    c.flag 'description', desc: 'Description of the public or private channel to create.'
+    c.flag 'org_wide', desc: '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.'
+    c.flag 'team_id', desc: 'The workspace to create the channel in. Note: this argument is required unless you set org_wide=true.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_create(options))
+    end
+  end
+
+  g.desc 'Delete a public or private channel.'
+  g.long_desc %( Delete a public or private channel. )
+  g.command 'delete' do |c|
+    c.flag 'channel_id', desc: 'The channel to delete.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_delete(options))
+    end
+  end
+
+  g.desc 'Get conversation preferences for a public or private channel.'
+  g.long_desc %( Get conversation preferences for a public or private channel. )
+  g.command 'getConversationPrefs' do |c|
+    c.flag 'channel_id', desc: 'The channel to get preferences for.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_getConversationPrefs(options))
+    end
+  end
+
+  g.desc "This API endpoint can be used by any admin to get a channel's retention policy."
+  g.long_desc %( This API endpoint can be used by any admin to get a channel's retention policy. )
+  g.command 'getCustomRetention' do |c|
+    c.flag 'channel_id', desc: 'The channel to get the retention policy for.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_getCustomRetention(options))
+    end
+  end
+
+  g.desc 'Get all the workspaces a given public or private channel is connected to within this Enterprise org.'
+  g.long_desc %( Get all the workspaces a given public or private channel is connected to within this Enterprise org. )
+  g.command 'getTeams' do |c|
+    c.flag 'channel_id', desc: 'The channel to determine connected workspaces within the organization for.'
+    c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
+    c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_getTeams(options))
+    end
+  end
+
+  g.desc 'Invite a user to a public or private channel.'
+  g.long_desc %( Invite a user to a public or private channel. )
+  g.command 'invite' do |c|
+    c.flag 'channel_id', desc: 'The channel that the users will be invited to.'
+    c.flag 'user_ids', desc: 'The users to invite.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_invite(options))
+    end
+  end
+
+  g.desc "This API endpoint can be used by any admin to remove a channel's retention policy."
+  g.long_desc %( This API endpoint can be used by any admin to remove a channel's retention policy. )
+  g.command 'removeCustomRetention' do |c|
+    c.flag 'channel_id', desc: 'The channel to set the retention policy for.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_removeCustomRetention(options))
+    end
+  end
+
+  g.desc 'Rename a public or private channel.'
+  g.long_desc %( Rename a public or private channel. )
+  g.command 'rename' do |c|
+    c.flag 'channel_id', desc: 'The channel to rename.'
+    c.flag 'name', desc: '.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_rename(options))
+    end
+  end
+
+  g.desc 'Search for public or private channels in an Enterprise organization.'
+  g.long_desc %( Search for public or private channels in an Enterprise organization. )
+  g.command 'search' do |c|
+    c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
+    c.flag 'limit', desc: 'Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.'
+    c.flag 'query', desc: 'Name of the the channel to query by.'
+    c.flag 'search_channel_types', desc: '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.'
+    c.flag 'sort', desc: '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.'
+    c.flag 'sort_dir', desc: '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).'
+    c.flag 'team_ids', desc: 'Comma separated string of team IDs, signifying the workspaces to search through.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_search(options))
+    end
+  end
+
+  g.desc 'Set the posting permissions for a public or private channel.'
+  g.long_desc %( Set the posting permissions for a public or private channel. )
+  g.command 'setConversationPrefs' do |c|
+    c.flag 'channel_id', desc: 'The channel to set the prefs for.'
+    c.flag 'prefs', desc: 'The prefs for this channel in a stringified JSON format.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_setConversationPrefs(options))
+    end
+  end
+
+  g.desc "This API endpoint can be used by any admin to set a channel's retention policy."
+  g.long_desc %( This API endpoint can be used by any admin to set a channel's retention policy. )
+  g.command 'setCustomRetention' do |c|
+    c.flag 'channel_id', desc: 'The channel to set the retention policy for.'
+    c.flag 'duration_days', desc: 'The message retention duration in days to set for this channel.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_setCustomRetention(options))
+    end
+  end
+
+  g.desc 'Set the workspaces in an Enterprise grid org that connect to a public or private channel.'
+  g.long_desc %( Set the workspaces in an Enterprise grid org that connect to a public or private channel. )
+  g.command 'setTeams' do |c|
+    c.flag 'channel_id', desc: 'The encoded channel_id to add or remove to workspaces.'
+    c.flag 'org_channel', desc: 'True if channel has to be converted to an org channel.'
+    c.flag 'target_team_ids', desc: 'A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.'
+    c.flag 'team_id', desc: 'The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_setTeams(options))
+    end
+  end
+
+  g.desc 'Unarchive a public or private channel.'
+  g.long_desc %( Unarchive a public or private channel. )
+  g.command 'unarchive' do |c|
+    c.flag 'channel_id', desc: 'The channel to unarchive.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_unarchive(options))
+    end
+  end
+end

data/bin/commands/admin_conversations_ekm.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminConversationsEkm methods.'
+command 'admin_conversations_ekm' do |g|
+  g.desc '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.'
+  g.long_desc %( 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. )
+  g.command 'listOriginalConnectedChannelInfo' do |c|
+    c.flag 'channel_ids', desc: 'A comma-separated list of channels to filter to.'
+    c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
+    c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
+    c.flag 'team_ids', desc: 'A comma-separated list of the workspaces to which the channels you would like returned belong.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_ekm_listOriginalConnectedChannelInfo(options))
+    end
+  end
+end

data/bin/commands/admin_conversations_restrictAccess.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'Add and remove user groups from conversations.'
+command 'admin_conversations_restrictAccess' do |g|
+  g.desc 'Add an allowlist of IDP groups for accessing a channel'
+  g.long_desc %( Add an allowlist of IDP groups for accessing a channel )
+  g.command 'addGroup' do |c|
+    c.flag 'channel_id', desc: 'The channel to link this group to.'
+    c.flag 'group_id', desc: 'The IDP Group ID to be an allowlist for the private channel.'
+    c.flag 'team_id', desc: '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.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_restrictAccess_addGroup(options))
+    end
+  end
+
+  g.desc 'List all IDP Groups linked to a channel'
+  g.long_desc %( List all IDP Groups linked to a channel )
+  g.command 'listGroups' do |c|
+    c.flag 'channel_id', desc: '.'
+    c.flag 'team_id', desc: '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.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_restrictAccess_listGroups(options))
+    end
+  end
+
+  g.desc 'Remove a linked IDP group linked from a private channel'
+  g.long_desc %( Remove a linked IDP group linked from a private channel )
+  g.command 'removeGroup' do |c|
+    c.flag 'channel_id', desc: 'The channel to remove the linked group from.'
+    c.flag 'group_id', desc: 'The IDP Group ID to remove from the private channel.'
+    c.flag 'team_id', desc: '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.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_restrictAccess_removeGroup(options))
+    end
+  end
+end

data/bin/commands/admin_conversations_whitelist.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'Add and remove user groups from conversations. Use admin.conversations.* equivalents instead.'
+command 'admin_conversations_whitelist' do |g|
+  g.desc 'Add an allowlist of IDP groups for accessing a channel'
+  g.long_desc %( Add an allowlist of IDP groups for accessing a channel )
+  g.command 'add' do |c|
+    c.flag 'channel_id', desc: 'The channel to whitelist a group for.'
+    c.flag 'group_id', desc: 'The IDP Group ID to whitelist for the private channel.'
+    c.flag 'team_id', desc: 'The workspace where the IDP Group and channel exist.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_whitelist_add(options))
+    end
+  end
+
+  g.desc 'List all IDP Groups linked to a channel'
+  g.long_desc %( List all IDP Groups linked to a channel )
+  g.command 'listGroupsLinkedToChannel' do |c|
+    c.flag 'channel_id', desc: '.'
+    c.flag 'team_id', desc: '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.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_whitelist_listGroupsLinkedToChannel(options))
+    end
+  end
+
+  g.desc 'Remove an allowlisted IDP group linked to a private channel'
+  g.long_desc %( Remove an allowlisted IDP group linked to a private channel )
+  g.command 'remove' do |c|
+    c.flag 'channel_id', desc: 'The channel to remove a whitelisted group for.'
+    c.flag 'group_id', desc: 'The IDP Group ID to remove from the private channel whitelist.'
+    c.flag 'team_id', desc: 'The workspace where the IDP Group and channel exist.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_whitelist_remove(options))
+    end
+  end
+end