slack-ruby-client 0.14.4 → 0.16.0

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

data/bin/commands/admin_emoji.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminEmoji methods.'
+command 'admin_emoji' do |g|
+  g.desc 'Add an emoji.'
+  g.long_desc %( Add an emoji. )
+  g.command 'add' do |c|
+    c.flag 'name', desc: 'The name of the emoji to be added. Colons (:myemoji:) around the value are not required, although they may be included.'
+    c.flag 'url', desc: 'The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_emoji_add(options))
+    end
+  end
+
+  g.desc 'Add an emoji alias.'
+  g.long_desc %( Add an emoji alias. )
+  g.command 'addAlias' do |c|
+    c.flag 'alias_for', desc: 'The alias of the emoji.'
+    c.flag 'name', desc: 'The name of the emoji to be aliased. Colons (:myemoji:) around the value are not required, although they may be included.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_emoji_addAlias(options))
+    end
+  end
+
+  g.desc 'List emoji for an Enterprise Grid organization.'
+  g.long_desc %( List emoji for an Enterprise Grid 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_emoji_list(options))
+    end
+  end
+
+  g.desc 'Remove an emoji across an Enterprise Grid organization'
+  g.long_desc %( Remove an emoji across an Enterprise Grid organization )
+  g.command 'remove' do |c|
+    c.flag 'name', desc: 'The name of the emoji to be removed. Colons (:myemoji:) around the value are not required, although they may be included.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_emoji_remove(options))
+    end
+  end
+
+  g.desc 'Rename an emoji.'
+  g.long_desc %( Rename an emoji. )
+  g.command 'rename' do |c|
+    c.flag 'name', desc: 'The name of the emoji to be renamed. Colons (:myemoji:) around the value are not required, although they may be included.'
+    c.flag 'new_name', desc: 'The new name of the emoji.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_emoji_rename(options))
+    end
+  end
+end

data/bin/commands/admin_inviteRequests.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminInviterequests methods.'
+command 'admin_inviteRequests' do |g|
+  g.desc 'Approve a workspace invite request.'
+  g.long_desc %( Approve a workspace invite request. )
+  g.command 'approve' do |c|
+    c.flag 'invite_request_id', desc: 'ID of the request to invite.'
+    c.flag 'team_id', desc: 'ID for the workspace where the invite request was made.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_inviteRequests_approve(options))
+    end
+  end
+
+  g.desc 'Deny a workspace invite request.'
+  g.long_desc %( Deny a workspace invite request. )
+  g.command 'deny' do |c|
+    c.flag 'invite_request_id', desc: 'ID of the request to invite.'
+    c.flag 'team_id', desc: 'ID for the workspace where the invite request was made.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_inviteRequests_deny(options))
+    end
+  end
+
+  g.desc 'List all pending workspace invite requests.'
+  g.long_desc %( List all pending workspace invite requests. )
+  g.command 'list' do |c|
+    c.flag 'cursor', desc: 'Value of the next_cursor field sent as part of the previous API response.'
+    c.flag 'limit', desc: 'The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive.'
+    c.flag 'team_id', desc: 'ID for the workspace where the invite requests were made.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_inviteRequests_list(options))
+    end
+  end
+end

data/bin/commands/admin_inviteRequests_approved.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminInviterequestsApproved methods.'
+command 'admin_inviteRequests_approved' do |g|
+  g.desc 'List all approved workspace invite requests.'
+  g.long_desc %( List all approved workspace invite requests. )
+  g.command 'list' do |c|
+    c.flag 'cursor', desc: 'Value of the next_cursor field sent as part of the previous API response.'
+    c.flag 'limit', desc: 'The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive.'
+    c.flag 'team_id', desc: 'ID for the workspace where the invite requests were made.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_inviteRequests_approved_list(options))
+    end
+  end
+end

data/bin/commands/admin_inviteRequests_denied.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminInviterequestsDenied methods.'
+command 'admin_inviteRequests_denied' do |g|
+  g.desc 'List all denied workspace invite requests.'
+  g.long_desc %( List all denied workspace invite requests. )
+  g.command 'list' do |c|
+    c.flag 'cursor', desc: 'Value of the next_cursor field sent as part of the previous api response.'
+    c.flag 'limit', desc: 'The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive.'
+    c.flag 'team_id', desc: 'ID for the workspace where the invite requests were made.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_inviteRequests_denied_list(options))
+    end
+  end
+end

data/bin/commands/admin_teams.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminTeams methods.'
+command 'admin_teams' do |g|
+  g.desc 'Create an Enterprise team.'
+  g.long_desc %( Create an Enterprise team. )
+  g.command 'create' do |c|
+    c.flag 'team_domain', desc: 'Team domain (for example, slacksoftballteam).'
+    c.flag 'team_name', desc: 'Team name (for example, Slack Softball Team).'
+    c.flag 'team_description', desc: 'Description for the team.'
+    c.flag 'team_discoverability', desc: "Who can join the team. A team's discoverability can be open, closed, invite_only, or unlisted."
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_teams_create(options))
+    end
+  end
+
+  g.desc 'List all teams on an Enterprise organization'
+  g.long_desc %( List all teams on an Enterprise 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 - 100 both inclusive.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_teams_list(options))
+    end
+  end
+end

data/bin/commands/admin_teams_admins.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminTeamsAdmins methods.'
+command 'admin_teams_admins' do |g|
+  g.desc 'List all of the admins on a given workspace.'
+  g.long_desc %( List all of the admins on a given workspace. )
+  g.command 'list' do |c|
+    c.flag 'team_id', desc: '.'
+    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.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_teams_admins_list(options))
+    end
+  end
+end

data/bin/commands/admin_teams_owners.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminTeamsOwners methods.'
+command 'admin_teams_owners' do |g|
+  g.desc 'List all of the owners on a given workspace.'
+  g.long_desc %( List all of the owners on a given workspace. )
+  g.command 'list' do |c|
+    c.flag 'team_id', desc: '.'
+    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_teams_owners_list(options))
+    end
+  end
+end

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 up to one hundred default channels to an IDP group.'
+  g.long_desc %( Add up to one hundred 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 '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.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
+    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 'user_id', desc: 'The ID of the user to set an expiration for.'
+    c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
+    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