module Slack::Web::Api::Endpoints::Usergroups

Public Instance Methods

usergroups_create(options = {}) click to toggle source

Create a User Group

@option options [Object] :name

A name for the User Group. Must be unique among User Groups.

@option options [Object] :channels

A comma separated string of encoded channel IDs for which the User Group uses as a default.

@option options [Object] :description

A short description of the User Group.

@option options [Object] :handle

A mention handle. Must be unique among channels, users and User Groups.

@option options [Object] :include_count

Include the number of users in each User Group.

@option options [Object] :team_id

Encoded team id where the user group has to be created, required if org token is used.

@see api.slack.com/methods/usergroups.create @see github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.create.json

# File lib/slack/web/api/endpoints/usergroups.rb, line 26
def usergroups_create(options = {})
  throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
  post('usergroups.create', options)
end
usergroups_disable(options = {}) click to toggle source

Disable an existing User Group

@option options [Object] :usergroup

The encoded ID of the User Group to disable.

@option options [Object] :include_count

Include the number of users in the User Group.

@option options [Object] :team_id

Encoded team id where the user group is, required if org token is used.

@see api.slack.com/methods/usergroups.disable @see github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.disable.json

# File lib/slack/web/api/endpoints/usergroups.rb, line 42
def usergroups_disable(options = {})
  throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
  post('usergroups.disable', options)
end
usergroups_enable(options = {}) click to toggle source

Enable a User Group

@option options [Object] :usergroup

The encoded ID of the User Group to enable.

@option options [Object] :include_count

Include the number of users in the User Group.

@option options [Object] :team_id

Encoded team id where the user group is, required if org token is used.

@see api.slack.com/methods/usergroups.enable @see github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.enable.json

# File lib/slack/web/api/endpoints/usergroups.rb, line 58
def usergroups_enable(options = {})
  throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
  post('usergroups.enable', options)
end
usergroups_list(options = {}) click to toggle source

List all User Groups for a team

@option options [Object] :include_count

Include the number of users in each User Group.

@option options [Object] :include_disabled

Include disabled User Groups.

@option options [Object] :include_users

Include the list of users for each User Group.

@option options [Object] :team_id

encoded team id to list user groups in, required if org token is used.

@see api.slack.com/methods/usergroups.list @see github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.list.json

# File lib/slack/web/api/endpoints/usergroups.rb, line 76
def usergroups_list(options = {})
  post('usergroups.list', options)
end
usergroups_update(options = {}) click to toggle source

Update an existing User Group

@option options [Object] :usergroup

The encoded ID of the User Group to update.

@option options [Object] :channels

A comma separated string of encoded channel IDs for which the User Group uses as a default.

@option options [Object] :description

A short description of the User Group.

@option options [Object] :handle

A mention handle. Must be unique among channels, users and User Groups.

@option options [Object] :include_count

Include the number of users in the User Group.

@option options [Object] :name

A name for the User Group. Must be unique among User Groups.

@option options [Object] :team_id

encoded team id where the user group exists, required if org token is used.

@see api.slack.com/methods/usergroups.update @see github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.update.json

# File lib/slack/web/api/endpoints/usergroups.rb, line 99
def usergroups_update(options = {})
  throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
  post('usergroups.update', options)
end