module Slack::Web::Api::Endpoints::AdminTeamsSettings

Public Instance Methods

admin_teams_settings_info(options = {}) click to toggle source

Fetch information about settings in a workspace

@option options [Object] :team_id

.

@see api.slack.com/methods/admin.teams.settings.info @see github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.settings/admin.teams.settings.info.json

# File lib/slack/web/api/endpoints/admin_teams_settings.rb, line 16
def admin_teams_settings_info(options = {})
  throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
  post('admin.teams.settings.info', options)
end
admin_teams_settings_setDefaultChannels(options = {}) click to toggle source

Set the default channels of a workspace.

@option options [Object] :channel_ids

An array of channel IDs.

@option options [Object] :team_id

ID for the workspace to set the default channel for.

@see api.slack.com/methods/admin.teams.settings.setDefaultChannels @see github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.settings/admin.teams.settings.setDefaultChannels.json

# File lib/slack/web/api/endpoints/admin_teams_settings.rb, line 30
def admin_teams_settings_setDefaultChannels(options = {})
  throw ArgumentError.new('Required arguments :channel_ids missing') if options[:channel_ids].nil?
  throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
  post('admin.teams.settings.setDefaultChannels', options)
end
admin_teams_settings_setDescription(options = {}) click to toggle source

Set the description of a given workspace.

@option options [Object] :description

The new description for the workspace.

@option options [Object] :team_id

ID for the workspace to set the description for.

@see api.slack.com/methods/admin.teams.settings.setDescription @see github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.settings/admin.teams.settings.setDescription.json

# File lib/slack/web/api/endpoints/admin_teams_settings.rb, line 45
def admin_teams_settings_setDescription(options = {})
  throw ArgumentError.new('Required arguments :description missing') if options[:description].nil?
  throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
  post('admin.teams.settings.setDescription', options)
end
admin_teams_settings_setDiscoverability(options = {}) click to toggle source

An API method that allows admins to set the discoverability of a given workspace

@option options [Object] :discoverability

This workspace's discovery setting. It must be set to one of open, invite_only, closed, or unlisted.

@option options [Object] :team_id

The ID of the workspace to set discoverability on.

@see api.slack.com/methods/admin.teams.settings.setDiscoverability @see github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.settings/admin.teams.settings.setDiscoverability.json

# File lib/slack/web/api/endpoints/admin_teams_settings.rb, line 60
def admin_teams_settings_setDiscoverability(options = {})
  throw ArgumentError.new('Required arguments :discoverability missing') if options[:discoverability].nil?
  throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
  post('admin.teams.settings.setDiscoverability', options)
end
admin_teams_settings_setIcon(options = {}) click to toggle source

Sets the icon of a workspace.

@option options [Object] :image_url

Image URL for the icon.

@option options [Object] :team_id

ID for the workspace to set the icon for.

@see api.slack.com/methods/admin.teams.settings.setIcon @see github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.settings/admin.teams.settings.setIcon.json

# File lib/slack/web/api/endpoints/admin_teams_settings.rb, line 75
def admin_teams_settings_setIcon(options = {})
  throw ArgumentError.new('Required arguments :image_url missing') if options[:image_url].nil?
  throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
  post('admin.teams.settings.setIcon', options)
end
admin_teams_settings_setName(options = {}) click to toggle source

Set the name of a given workspace.

@option options [Object] :name

The new name of the workspace.

@option options [Object] :team_id

ID for the workspace to set the name for.

@see api.slack.com/methods/admin.teams.settings.setName @see github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.settings/admin.teams.settings.setName.json

# File lib/slack/web/api/endpoints/admin_teams_settings.rb, line 90
def admin_teams_settings_setName(options = {})
  throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
  throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
  post('admin.teams.settings.setName', options)
end