slack-ruby-client 0.11.0 → 2.7.0

data/bin/commands/stars.rb

@@ -1,36 +1,46 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Stars methods.'
-command 'stars' do |g|
-  g.desc 'Adds a star to an item.'
-  g.long_desc %( Adds a star to an item. )
-  g.command 'add' do |c|
-    c.flag 'channel', desc: 'Channel to add star to, or channel where the message to add star to was posted (used with timestamp).'
-    c.flag 'file', desc: 'File to add star to.'
-    c.flag 'file_comment', desc: 'File comment to add star to.'
-    c.flag 'timestamp', desc: 'Timestamp of the message to add star to.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.stars_add(options))
-    end
-  end
+module Slack
+  module Cli
+    class App
+      desc 'Stars methods.'
+      command 'stars' do |g|
+        g.desc 'Save an item for later. Formerly known as adding a star.'
+        g.long_desc %( Save an item for later. Formerly known as adding a star. )
+        g.command 'add' do |c|
+          c.flag 'channel', desc: 'Channel to add star to, or channel where the message to add star to was posted (used with timestamp).'
+          c.flag 'file', desc: 'File to add star to.'
+          c.flag 'file_comment', desc: 'File comment to add star to.'
+          c.flag 'timestamp', desc: 'Timestamp of the message to add star to.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.stars_add(options))
+          end
+        end
 
-  g.desc 'Lists stars for a user.'
-  g.long_desc %( Lists stars for a user. )
-  g.command 'list' do |c|
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.stars_list(options))
-    end
-  end
+        g.desc "Listed a user's saved items, formerly known as stars."
+        g.long_desc %( Listed a user's saved items, formerly known as stars. )
+        g.command 'list' do |c|
+          c.flag 'cursor', desc: "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection. See pagination for more details."
+          c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached."
+          c.flag 'team_id', desc: 'encoded team id to list stars in, required if org token is used.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.stars_list(options))
+          end
+        end
 
-  g.desc 'Removes a star from an item.'
-  g.long_desc %( Removes a star from an item. )
-  g.command 'remove' do |c|
-    c.flag 'channel', desc: 'Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).'
-    c.flag 'file', desc: 'File to remove star from.'
-    c.flag 'file_comment', desc: 'File comment to remove star from.'
-    c.flag 'timestamp', desc: 'Timestamp of the message to remove star from.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.stars_remove(options))
+        g.desc 'Removes a saved item (star) from an item.'
+        g.long_desc %( Removes a saved item (star) from an item. )
+        g.command 'remove' do |c|
+          c.flag 'channel', desc: 'Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).'
+          c.flag 'file', desc: 'File to remove star from.'
+          c.flag 'file_comment', desc: 'File comment to remove star from.'
+          c.flag 'timestamp', desc: 'Timestamp of the message to remove star from.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.stars_remove(options))
+          end
+        end
+      end
     end
   end
 end

data/bin/commands/team.rb

@@ -1,42 +1,58 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Team methods.'
-command 'team' do |g|
-  g.desc 'Gets the access logs for the current team.'
-  g.long_desc %( Gets the access logs for the current team. )
-  g.command 'accessLogs' do |c|
-    c.flag 'before', desc: 'End of time range of logs to include in results (inclusive).'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.team_accessLogs(options))
-    end
-  end
+module Slack
+  module Cli
+    class App
+      desc 'Team methods.'
+      command 'team' do |g|
+        g.desc 'Gets the access logs for the current team.'
+        g.long_desc %( Gets the access logs for the current team. )
+        g.command 'accessLogs' do |c|
+          c.flag 'before', desc: 'End of time range of logs to include in results (inclusive).'
+          c.flag 'cursor', desc: "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection. See pagination for more details."
+          c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. If specified, result is returned using a cursor-based approach instead of a classic one."
+          c.flag 'team_id', desc: 'encoded team id to get logs from, required if org token is used.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.team_accessLogs(options))
+          end
+        end
 
-  g.desc 'Gets billable users information for the current team.'
-  g.long_desc %( Gets billable users information for the current team. )
-  g.command 'billableInfo' do |c|
-    c.flag 'user', desc: 'A user to retrieve the billable information for. Defaults to all users.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.team_billableInfo(options))
-    end
-  end
+        g.desc 'Gets billable users information for the current team.'
+        g.long_desc %( Gets billable users information for the current team. )
+        g.command 'billableInfo' do |c|
+          c.flag 'cursor', desc: '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.'
+          c.flag 'limit', desc: 'The maximum number of items to return.'
+          c.flag 'team_id', desc: 'encoded team id to get the billable information from, required if org token is used.'
+          c.flag 'user', desc: 'A user to retrieve the billable information for. Defaults to all users.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.team_billableInfo(options))
+          end
+        end
 
-  g.desc 'Gets information about the current team.'
-  g.long_desc %( Gets information about the current team. )
-  g.command 'info' do |c|
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.team_info(options))
-    end
-  end
+        g.desc 'Gets information about the current team.'
+        g.long_desc %( Gets information about the current team. )
+        g.command 'info' do |c|
+          c.flag 'domain', desc: "Query by domain instead of team (only when team is null). This only works for domains in the same enterprise as the querying team token. This also expects the domain to belong to a team and not the enterprise itself. This is the value set up for the 'Joining This Workspace' workspace setting. If it contains more than one domain, the field will contain multiple comma-separated domain values. If no domain is set, the field is empty."
+          c.flag 'team', desc: 'Team to get info about; if omitted, will return information about the current team.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.team_info(options))
+          end
+        end
 
-  g.desc 'Gets the integration logs for the current team.'
-  g.long_desc %( Gets the integration logs for the current team. )
-  g.command 'integrationLogs' do |c|
-    c.flag 'app_id', desc: 'Filter logs to this Slack app. Defaults to all logs.'
-    c.flag 'change_type', desc: 'Filter logs with this change type. Defaults to all logs.'
-    c.flag 'service_id', desc: 'Filter logs to this service. Defaults to all logs.'
-    c.flag 'user', desc: "Filter logs generated by this user's actions. Defaults to all logs."
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.team_integrationLogs(options))
+        g.desc 'Gets the integration logs for the current team.'
+        g.long_desc %( Gets the integration logs for the current team. )
+        g.command 'integrationLogs' do |c|
+          c.flag 'app_id', desc: 'Filter logs to this Slack app. Defaults to all logs.'
+          c.flag 'change_type', desc: 'Filter logs with this change type. Possible values are added, removed, enabled, disabled, and updated. Defaults to all logs.'
+          c.flag 'service_id', desc: 'Filter logs to this service. Defaults to all logs.'
+          c.flag 'team_id', desc: 'encoded team id to get logs from, required if org token is used.'
+          c.flag 'user', desc: "Filter logs generated by this user's actions. Defaults to all logs."
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.team_integrationLogs(options))
+          end
+        end
+      end
     end
   end
 end

data/bin/commands/team_billing.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Cli
+    class App
+      desc 'TeamBilling methods.'
+      command 'team_billing' do |g|
+        g.desc "Reads a workspace's billing plan information."
+        g.long_desc %( Reads a workspace's billing plan information. )
+        g.command 'info' do |c|
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.team_billing_info(options))
+          end
+        end
+      end
+    end
+  end
+end

data/bin/commands/team_externalTeams.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Cli
+    class App
+      desc 'TeamExternalteams methods.'
+      command 'team_externalTeams' do |g|
+        g.desc 'Disconnect an external organization.'
+        g.long_desc %( Disconnect an external organization. )
+        g.command 'disconnect' do |c|
+          c.flag 'target_team', desc: 'The team ID of the target team.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.team_externalTeams_disconnect(options))
+          end
+        end
+
+        g.desc 'Returns a list of all the external teams connected and details about the connection.'
+        g.long_desc %( Returns a list of all the external teams connected and details about the connection. )
+        g.command 'list' do |c|
+          c.flag 'connection_status_filter', desc: 'Status of the connected team.'
+          c.flag 'cursor', desc: "Paginate through collections of data by setting parameter to the team_id attribute returned by a previous request's response_metadata. If not provided, the first page of the collection is returned. See pagination for more detail."
+          c.flag 'limit', desc: 'The maximum number of items to return per page.'
+          c.flag 'slack_connect_pref_filter', desc: 'Filters connected orgs by Slack Connect pref override(s). Value can be: approved_orgs_only allow_sc_file_uploads profile_visibility away_team_sc_invite_permissions accept_sc_invites sc_mpdm_to_private require_sc_channel_for_sc_dm external_awareness_context_bar.'
+          c.flag 'sort_direction', desc: 'Direction to sort in asc or desc.'
+          c.flag 'sort_field', desc: 'Name of the parameter that we are sorting by.'
+          c.flag 'workspace_filter', desc: 'Shows connected orgs which are connected on a specified encoded workspace ID.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.team_externalTeams_list(options))
+          end
+        end
+      end
+    end
+  end
+end

data/bin/commands/team_preferences.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Cli
+    class App
+      desc 'TeamPreferences methods.'
+      command 'team_preferences' do |g|
+        g.desc "Retrieve a list of a workspace's team preferences."
+        g.long_desc %( Retrieve a list of a workspace's team preferences. )
+        g.command 'list' do |c|
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.team_preferences_list(options))
+          end
+        end
+      end
+    end
+  end
+end

data/bin/commands/team_profile.rb

@@ -1,13 +1,20 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'TeamProfile methods.'
-command 'team_profile' do |g|
-  g.desc "Retrieve a team's profile."
-  g.long_desc %( Retrieve a team's profile. )
-  g.command 'get' do |c|
-    c.flag 'visibility', desc: 'Filter by visibility.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.team_profile_get(options))
+module Slack
+  module Cli
+    class App
+      desc 'TeamProfile methods.'
+      command 'team_profile' do |g|
+        g.desc "Retrieve a team's profile."
+        g.long_desc %( Retrieve a team's profile. )
+        g.command 'get' do |c|
+          c.flag 'visibility', desc: 'Filter by visibility.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.team_profile_get(options))
+          end
+        end
+      end
     end
   end
 end

data/bin/commands/tooling_tokens.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Cli
+    class App
+      desc 'ToolingTokens methods.'
+      command 'tooling_tokens' do |g|
+        g.desc 'Exchanges a refresh token for a new app configuration token.'
+        g.long_desc %( Exchanges a refresh token for a new app configuration token. )
+        g.command 'rotate' do |c|
+          c.flag 'refresh_token', desc: 'The xoxe refresh token that was issued along with the old app configuration token.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.tooling_tokens_rotate(options))
+          end
+        end
+      end
+    end
+  end
+end

data/bin/commands/usergroups.rb

@@ -1,62 +1,78 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc "Get info on your team's User Groups."
-command 'usergroups' do |g|
-  g.desc 'Create a User Group'
-  g.long_desc %( Create a User Group )
-  g.command 'create' do |c|
-    c.flag 'name', desc: 'A name for the User Group. Must be unique among User Groups.'
-    c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.'
-    c.flag 'description', desc: 'A short description of the User Group.'
-    c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and User Groups.'
-    c.flag 'include_count', desc: 'Include the number of users in each User Group.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.usergroups_create(options))
-    end
-  end
+module Slack
+  module Cli
+    class App
+      desc 'Usergroups methods.'
+      command 'usergroups' do |g|
+        g.desc 'Create a User Group.'
+        g.long_desc %( Create a User Group. )
+        g.command 'create' do |c|
+          c.flag 'name', desc: 'A name for the User Group. Must be unique among User Groups.'
+          c.flag 'additional_channels', desc: 'A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.'
+          c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.'
+          c.flag 'description', desc: 'A short description of the User Group.'
+          c.flag 'enable_section', desc: 'Configure this user group to show as a sidebar section for all group members. Note: Only relevant if group has 1 or more default channels added.'
+          c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and User Groups.'
+          c.flag 'include_count', desc: 'Include the number of users in each User Group.'
+          c.flag 'team_id', desc: 'Encoded team id where the user group has to be created, required if org token is used.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.usergroups_create(options))
+          end
+        end
 
-  g.desc 'Disable an existing User Group'
-  g.long_desc %( Disable an existing User Group )
-  g.command 'disable' do |c|
-    c.flag 'usergroup', desc: 'The encoded ID of the User Group to disable.'
-    c.flag 'include_count', desc: 'Include the number of users in the User Group.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.usergroups_disable(options))
-    end
-  end
+        g.desc 'Disable an existing User Group.'
+        g.long_desc %( Disable an existing User Group. )
+        g.command 'disable' do |c|
+          c.flag 'usergroup', desc: 'The encoded ID of the User Group to disable.'
+          c.flag 'include_count', desc: 'Include the number of users in the User Group.'
+          c.flag 'team_id', desc: 'Encoded target team id where the user group is, required if org token is used.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.usergroups_disable(options))
+          end
+        end
 
-  g.desc 'Enable a User Group'
-  g.long_desc %( Enable a User Group )
-  g.command 'enable' do |c|
-    c.flag 'usergroup', desc: 'The encoded ID of the User Group to enable.'
-    c.flag 'include_count', desc: 'Include the number of users in the User Group.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.usergroups_enable(options))
-    end
-  end
+        g.desc 'Enable a User Group.'
+        g.long_desc %( Enable a User Group. )
+        g.command 'enable' do |c|
+          c.flag 'usergroup', desc: 'The encoded ID of the User Group to enable.'
+          c.flag 'include_count', desc: 'Include the number of users in the User Group.'
+          c.flag 'team_id', desc: 'Encoded team id where the user group is, required if org token is used.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.usergroups_enable(options))
+          end
+        end
 
-  g.desc 'List all User Groups for a team'
-  g.long_desc %( List all User Groups for a team )
-  g.command 'list' do |c|
-    c.flag 'include_count', desc: 'Include the number of users in each User Group.'
-    c.flag 'include_disabled', desc: 'Include disabled User Groups.'
-    c.flag 'include_users', desc: 'Include the list of users for each User Group.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.usergroups_list(options))
-    end
-  end
+        g.desc 'List all User Groups for a team.'
+        g.long_desc %( List all User Groups for a team. )
+        g.command 'list' do |c|
+          c.flag 'include_count', desc: 'Include the number of users in each User Group.'
+          c.flag 'include_disabled', desc: 'Include disabled User Groups.'
+          c.flag 'include_users', desc: 'Include the list of users for each User Group.'
+          c.flag 'team_id', desc: 'encoded team id to list user groups in, required if org token is used.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.usergroups_list(options))
+          end
+        end
 
-  g.desc 'Update an existing User Group'
-  g.long_desc %( Update an existing User Group )
-  g.command 'update' do |c|
-    c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
-    c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.'
-    c.flag 'description', desc: 'A short description of the User Group.'
-    c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and User Groups.'
-    c.flag 'include_count', desc: 'Include the number of users in the User Group.'
-    c.flag 'name', desc: 'A name for the User Group. Must be unique among User Groups.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.usergroups_update(options))
+        g.desc 'Update an existing User Group.'
+        g.long_desc %( Update an existing User Group. )
+        g.command 'update' do |c|
+          c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
+          c.flag 'additional_channels', desc: 'A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.'
+          c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.'
+          c.flag 'description', desc: 'A short description of the User Group.'
+          c.flag 'enable_section', desc: 'Configure this user group to show as a sidebar section for all group members. Note: Only relevant if group has 1 or more default channels added.'
+          c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and User Groups.'
+          c.flag 'include_count', desc: 'Include the number of users in the User Group.'
+          c.flag 'name', desc: 'A name for the User Group. Must be unique among User Groups.'
+          c.flag 'team_id', desc: 'encoded team id where the user group exists, required if org token is used.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.usergroups_update(options))
+          end
+        end
+      end
     end
   end
 end

data/bin/commands/usergroups_users.rb

@@ -1,25 +1,36 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'UsergroupsUsers methods.'
-command 'usergroups_users' do |g|
-  g.desc 'List all users in a User Group'
-  g.long_desc %( List all users in a User Group )
-  g.command 'list' do |c|
-    c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
-    c.flag 'include_disabled', desc: 'Allow results that involve disabled User Groups.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.usergroups_users_list(options))
-    end
-  end
+module Slack
+  module Cli
+    class App
+      desc 'UsergroupsUsers methods.'
+      command 'usergroups_users' do |g|
+        g.desc 'List all users in a User Group.'
+        g.long_desc %( List all users in a User Group. )
+        g.command 'list' do |c|
+          c.flag 'usergroup', desc: 'The encoded ID of the User Group to list users for.'
+          c.flag 'include_disabled', desc: 'Allow results that involve disabled User Groups.'
+          c.flag 'team_id', desc: 'encoded team id where the user group exists, required if org token is used.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.usergroups_users_list(options))
+          end
+        end
 
-  g.desc 'Update the list of users for a User Group'
-  g.long_desc %( Update the list of users for a User Group )
-  g.command 'update' do |c|
-    c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
-    c.flag 'users', desc: 'A comma separated string of encoded user IDs that represent the entire list of users for the User Group.'
-    c.flag 'include_count', desc: 'Include the number of users in the User Group.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.usergroups_users_update(options))
+        g.desc 'Update the list of users for a user group.'
+        g.long_desc %( Update the list of users for a user group. )
+        g.command 'update' do |c|
+          c.flag 'usergroup', desc: 'The encoded ID of the user group to update.'
+          c.flag 'users', desc: 'A comma separated string of encoded user IDs that represent the entire list of users for the user group.'
+          c.flag 'additional_channels', desc: 'A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.'
+          c.flag 'include_count', desc: 'Include the number of users in the user group.'
+          c.flag 'is_shared', desc: 'Boolean to identify if the API is getting called when a shared section is getting shared.'
+          c.flag 'team_id', desc: 'encoded team id where the user group exists, required if org token is used.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.usergroups_users_update(options))
+          end
+        end
+      end
     end
   end
 end