slack-ruby-client 0.14.2 → 0.15.0

data/bin/commands/admin_teams_settings.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminTeamsSettings methods.'
+command 'admin_teams_settings' do |g|
+  g.desc 'Fetch information about settings in a workspace'
+  g.long_desc %( Fetch information about settings in a workspace )
+  g.command 'info' do |c|
+    c.flag 'team_id', desc: '.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_teams_settings_info(options))
+    end
+  end
+
+  g.desc 'Set the default channels of a workspace.'
+  g.long_desc %( Set the default channels of a workspace. )
+  g.command 'setDefaultChannels' do |c|
+    c.flag 'channel_ids', desc: 'An array of channel IDs.'
+    c.flag 'team_id', desc: 'ID for the workspace to set the default channel for.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_teams_settings_setDefaultChannels(options))
+    end
+  end
+
+  g.desc 'Set the description of a given workspace.'
+  g.long_desc %( Set the description of a given workspace. )
+  g.command 'setDescription' do |c|
+    c.flag 'description', desc: 'The new description for the workspace.'
+    c.flag 'team_id', desc: 'ID for the workspace to set the description for.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_teams_settings_setDescription(options))
+    end
+  end
+
+  g.desc 'An API method that allows admins to set the discoverability of a given workspace'
+  g.long_desc %( An API method that allows admins to set the discoverability of a given workspace )
+  g.command 'setDiscoverability' do |c|
+    c.flag 'discoverability', desc: "This workspace's discovery setting. It must be set to one of open, invite_only, closed, or unlisted."
+    c.flag 'team_id', desc: 'The ID of the workspace to set discoverability on.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_teams_settings_setDiscoverability(options))
+    end
+  end
+
+  g.desc 'Sets the icon of a workspace.'
+  g.long_desc %( Sets the icon of a workspace. )
+  g.command 'setIcon' do |c|
+    c.flag 'image_url', desc: 'Image URL for the icon.'
+    c.flag 'team_id', desc: 'ID for the workspace to set the icon for.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_teams_settings_setIcon(options))
+    end
+  end
+
+  g.desc 'Set the name of a given workspace.'
+  g.long_desc %( Set the name of a given workspace. )
+  g.command 'setName' do |c|
+    c.flag 'name', desc: 'The new name of the workspace.'
+    c.flag 'team_id', desc: 'ID for the workspace to set the name for.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_teams_settings_setName(options))
+    end
+  end
+end

data/bin/commands/admin_usergroups.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminUsergroups methods.'
+command 'admin_usergroups' do |g|
+  g.desc 'Add one or more default channels to an IDP group.'
+  g.long_desc %( Add one or more default channels to an IDP group. )
+  g.command 'addChannels' do |c|
+    c.flag 'channel_ids', desc: 'Comma separated string of channel IDs.'
+    c.flag 'usergroup_id', desc: 'ID of the IDP group to add default channels for.'
+    c.flag 'team_id', desc: 'The workspace to add default channels in.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_usergroups_addChannels(options))
+    end
+  end
+
+  g.desc 'Associate one or more default workspaces with an organization-wide IDP group.'
+  g.long_desc %( Associate one or more default workspaces with an organization-wide IDP group. )
+  g.command 'addTeams' do |c|
+    c.flag 'team_ids', desc: 'A comma separated list of encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token.'
+    c.flag 'usergroup_id', desc: 'An encoded usergroup (IDP Group) ID.'
+    c.flag 'auto_provision', desc: 'When true, this method automatically creates new workspace accounts for the IDP group members.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_usergroups_addTeams(options))
+    end
+  end
+
+  g.desc 'List the channels linked to an org-level IDP group (user group).'
+  g.long_desc %( List the channels linked to an org-level IDP group (user group). )
+  g.command 'listChannels' do |c|
+    c.flag 'usergroup_id', desc: 'ID of the IDP group to list default channels for.'
+    c.flag 'include_num_members', desc: 'Flag to include or exclude the count of members per channel.'
+    c.flag 'team_id', desc: 'ID of the the workspace.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_usergroups_listChannels(options))
+    end
+  end
+
+  g.desc 'Remove one or more default channels from an org-level IDP group (user group).'
+  g.long_desc %( Remove one or more default channels from an org-level IDP group (user group). )
+  g.command 'removeChannels' do |c|
+    c.flag 'channel_ids', desc: 'Comma-separated string of channel IDs.'
+    c.flag 'usergroup_id', desc: 'ID of the IDP Group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_usergroups_removeChannels(options))
+    end
+  end
+end

data/bin/commands/admin_users.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminUsers methods.'
+command 'admin_users' do |g|
+  g.desc 'Add an Enterprise user to a workspace.'
+  g.long_desc %( Add an Enterprise user to a workspace. )
+  g.command 'assign' do |c|
+    c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
+    c.flag 'user_id', desc: 'The ID of the user to add to the workspace.'
+    c.flag 'channel_ids', desc: 'Comma separated values of channel IDs to add user in the new workspace.'
+    c.flag 'is_restricted', desc: 'True if user should be added to the workspace as a guest.'
+    c.flag 'is_ultra_restricted', desc: 'True if user should be added to the workspace as a single-channel guest.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_users_assign(options))
+    end
+  end
+
+  g.desc 'Invite a user to a workspace.'
+  g.long_desc %( Invite a user to a workspace. )
+  g.command 'invite' do |c|
+    c.flag 'channel_ids', desc: 'A comma-separated list of channel_ids for this user to join. At least one channel is required.'
+    c.flag 'email', desc: 'The email address of the person to invite.'
+    c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
+    c.flag 'custom_message', desc: 'An optional message to send to the user in the invite email.'
+    c.flag 'guest_expiration_ts', desc: 'Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.'
+    c.flag 'is_restricted', desc: 'Is this user a multi-channel guest user? (default: false).'
+    c.flag 'is_ultra_restricted', desc: 'Is this user a single channel guest user? (default: false).'
+    c.flag 'real_name', desc: 'Full name of the user.'
+    c.flag 'resend', desc: 'Allow this invite to be resent in the future if a user has not signed up yet. (default: false).'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_users_invite(options))
+    end
+  end
+
+  g.desc 'List users on a workspace'
+  g.long_desc %( List users on a workspace )
+  g.command 'list' do |c|
+    c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
+    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: 'Limit for how many users to be retrieved per page.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_users_list(options))
+    end
+  end
+
+  g.desc 'Remove a user from a workspace.'
+  g.long_desc %( Remove a user from a workspace. )
+  g.command 'remove' do |c|
+    c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
+    c.flag 'user_id', desc: 'The ID of the user to remove.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_users_remove(options))
+    end
+  end
+
+  g.desc 'Set an existing guest, regular user, or owner to be an admin user.'
+  g.long_desc %( Set an existing guest, regular user, or owner to be an admin user. )
+  g.command 'setAdmin' do |c|
+    c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
+    c.flag 'user_id', desc: 'The ID of the user to designate as an admin.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_users_setAdmin(options))
+    end
+  end
+
+  g.desc 'Set an expiration for a guest user'
+  g.long_desc %( Set an expiration for a guest user )
+  g.command 'setExpiration' do |c|
+    c.flag 'expiration_ts', desc: 'Timestamp when guest account should be disabled.'
+    c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
+    c.flag 'user_id', desc: 'The ID of the user to set an expiration for.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_users_setExpiration(options))
+    end
+  end
+
+  g.desc 'Set an existing guest, regular user, or admin user to be a workspace owner.'
+  g.long_desc %( Set an existing guest, regular user, or admin user to be a workspace owner. )
+  g.command 'setOwner' do |c|
+    c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
+    c.flag 'user_id', desc: 'Id of the user to promote to owner.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_users_setOwner(options))
+    end
+  end
+
+  g.desc 'Set an existing guest user, admin user, or owner to be a regular user.'
+  g.long_desc %( Set an existing guest user, admin user, or owner to be a regular user. )
+  g.command 'setRegular' do |c|
+    c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
+    c.flag 'user_id', desc: 'The ID of the user to designate as a regular user.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_users_setRegular(options))
+    end
+  end
+end

data/bin/commands/admin_users_session.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminUsersSession methods.'
+command 'admin_users_session' do |g|
+  g.desc 'Wipes all valid sessions on all devices for a given user'
+  g.long_desc %( Wipes all valid sessions on all devices for a given user )
+  g.command 'reset' do |c|
+    c.flag 'user_id', desc: 'The ID of the user to wipe sessions for.'
+    c.flag 'mobile_only', desc: 'Only expire mobile sessions (default: false).'
+    c.flag 'web_only', desc: 'Only expire web sessions (default: false).'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_users_session_reset(options))
+    end
+  end
+end

data/bin/commands/api.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Api methods.'
 command 'api' do |g|
-  g.desc 'This method helps you test your calling code.'
-  g.long_desc %( This method helps you test your calling code. )
+  g.desc 'Checks API calling code.'
+  g.long_desc %( Checks API calling code. )
   g.command 'test' do |c|
     c.flag 'error', desc: 'Error response to return.'
     c.flag 'foo', desc: 'example property to return.'

data/bin/commands/apps.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Apps methods.'
 command 'apps' do |g|
-  g.desc 'This method uninstalls a workspace app. Unlike auth.revoke, which revokes a single token, this method revokes all tokens associated with a single installation of a workspace app.'
-  g.long_desc %( This method uninstalls a workspace app. Unlike auth.revoke, which revokes a single token, this method revokes all tokens associated with a single installation of a workspace app. )
+  g.desc 'Uninstalls your app from a workspace.'
+  g.long_desc %( Uninstalls your app from a workspace. )
   g.command 'uninstall' do |c|
     c.flag 'client_id', desc: 'Issued when you created your application.'
     c.flag 'client_secret', desc: 'Issued when you created your application.'

data/bin/commands/apps_permissions.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'AppsPermissions methods.'
 command 'apps_permissions' do |g|
-  g.desc 'This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.'
-  g.long_desc %( This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months. )
+  g.desc 'Returns list of permissions this app has on a team.'
+  g.long_desc %( Returns list of permissions this app has on a team. )
   g.command 'info' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.apps_permissions_info(options))
     end
   end
 
-  g.desc 'This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.'
-  g.long_desc %( This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months. )
+  g.desc 'Allows an app to request additional scopes'
+  g.long_desc %( Allows an app to request additional scopes )
   g.command 'request' do |c|
     c.flag 'scopes', desc: 'A comma separated list of scopes to request for.'
     c.flag 'trigger_id', desc: 'Token used to trigger the permissions API.'

data/bin/commands/apps_permissions_resources.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'AppsPermissionsResources methods.'
 command 'apps_permissions_resources' do |g|
-  g.desc 'This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.'
-  g.long_desc %( This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months. )
+  g.desc 'Returns list of resource grants this app has on a team.'
+  g.long_desc %( Returns list of resource grants this app has on a team. )
   g.command 'list' do |c|
     c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
     c.flag 'limit', desc: 'The maximum number of items to return.'

data/bin/commands/apps_permissions_scopes.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'AppsPermissionsScopes methods.'
 command 'apps_permissions_scopes' do |g|
-  g.desc 'This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.'
-  g.long_desc %( This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months. )
+  g.desc 'Returns list of scopes this app has on a team.'
+  g.long_desc %( Returns list of scopes this app has on a team. )
   g.command 'list' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.apps_permissions_scopes_list(options))

data/bin/commands/apps_permissions_users.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'AppsPermissionsUsers methods.'
 command 'apps_permissions_users' do |g|
-  g.desc 'This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.'
-  g.long_desc %( This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months. )
+  g.desc 'Returns list of user grants and corresponding scopes this app has on a team.'
+  g.long_desc %( Returns list of user grants and corresponding scopes this app has on a team. )
   g.command 'list' do |c|
     c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
     c.flag 'limit', desc: 'The maximum number of items to return.'
@@ -12,8 +13,8 @@ command 'apps_permissions_users' do |g|
     end
   end
 
-  g.desc 'This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.'
-  g.long_desc %( This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months. )
+  g.desc 'Enables an app to trigger a permissions modal to grant an app access to a user access scope.'
+  g.long_desc %( Enables an app to trigger a permissions modal to grant an app access to a user access scope. )
   g.command 'request' do |c|
     c.flag 'scopes', desc: 'A comma separated list of user scopes to request for.'
     c.flag 'trigger_id', desc: 'Token used to trigger the request.'

data/bin/commands/auth.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Auth methods.'
 command 'auth' do |g|
-  g.desc 'This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out.'
-  g.long_desc %( This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out. )
+  g.desc 'Revokes a token.'
+  g.long_desc %( Revokes a token. )
   g.command 'revoke' do |c|
     c.flag 'test', desc: 'Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.'
     c.action do |_global_options, options, _args|
@@ -11,8 +12,8 @@ command 'auth' do |g|
     end
   end
 
-  g.desc 'This method checks authentication and tells "you" who you are, even if you might be a bot.'
-  g.long_desc %( This method checks authentication and tells "you" who you are, even if you might be a bot. )
+  g.desc 'Checks authentication & identity.'
+  g.long_desc %( Checks authentication & identity. )
   g.command 'test' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.auth_test(options))

data/bin/commands/bots.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Bots methods.'
 command 'bots' do |g|
-  g.desc 'This method returns extended information about a bot user.'
-  g.long_desc %( This method returns extended information about a bot user. )
+  g.desc 'Gets information about a bot user.'
+  g.long_desc %( Gets information about a bot user. )
   g.command 'info' do |c|
     c.flag 'bot', desc: 'Bot user to get info on.'
     c.action do |_global_options, options, _args|

data/bin/commands/calls.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'Calls methods.'
+command 'calls' do |g|
+  g.desc 'Registers a new Call.'
+  g.long_desc %( Registers a new Call. )
+  g.command 'add' do |c|
+    c.flag 'external_unique_id', desc: 'An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.'
+    c.flag 'join_url', desc: 'The URL required for a client to join the Call.'
+    c.flag 'created_by', desc: 'The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required.'
+    c.flag 'date_start', desc: 'Call start time in UTC UNIX timestamp format.'
+    c.flag 'desktop_app_join_url', desc: 'When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.'
+    c.flag 'external_display_id', desc: 'An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.'
+    c.flag 'title', desc: 'The name of the Call.'
+    c.flag 'users', desc: 'The list of users to register as participants in the Call. Read more on how to specify users here.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.calls_add(options))
+    end
+  end
+
+  g.desc 'Ends a Call.'
+  g.long_desc %( Ends a Call. )
+  g.command 'end' do |c|
+    c.flag 'id', desc: 'id returned when registering the call using the calls.add method.'
+    c.flag 'duration', desc: 'Call duration in seconds.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.calls_end(options))
+    end
+  end
+
+  g.desc 'Returns information about a Call.'
+  g.long_desc %( Returns information about a Call. )
+  g.command 'info' do |c|
+    c.flag 'id', desc: 'id of the Call returned by the calls.add method.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.calls_info(options))
+    end
+  end
+
+  g.desc 'Updates information about a Call.'
+  g.long_desc %( Updates information about a Call. )
+  g.command 'update' do |c|
+    c.flag 'id', desc: 'id returned by the calls.add method.'
+    c.flag 'desktop_app_join_url', desc: 'When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.'
+    c.flag 'join_url', desc: 'The URL required for a client to join the Call.'
+    c.flag 'title', desc: 'The name of the Call.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.calls_update(options))
+    end
+  end
+end

data/bin/commands/calls_participants.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'CallsParticipants methods.'
+command 'calls_participants' do |g|
+  g.desc 'Registers new participants added to a Call.'
+  g.long_desc %( Registers new participants added to a Call. )
+  g.command 'add' do |c|
+    c.flag 'id', desc: 'id returned by the calls.add method.'
+    c.flag 'users', desc: 'The list of users to add as participants in the Call. Read more on how to specify users here.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.calls_participants_add(options))
+    end
+  end
+
+  g.desc 'Registers participants removed from a Call.'
+  g.long_desc %( Registers participants removed from a Call. )
+  g.command 'remove' do |c|
+    c.flag 'id', desc: 'id returned by the calls.add method.'
+    c.flag 'users', desc: 'The list of users to remove as participants in the Call. Read more on how to specify users here.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.calls_participants_remove(options))
+    end
+  end
+end