slack-ruby-client 0.9.0 → 0.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. checksums.yaml +4 -4
  2. data/.travis.yml +1 -8
  3. data/CHANGELOG.md +4 -0
  4. data/README.md +1 -1
  5. data/bin/commands.rb +1 -0
  6. data/bin/commands/api.rb +2 -2
  7. data/bin/commands/apps_permissions.rb +22 -0
  8. data/bin/commands/auth.rb +4 -4
  9. data/bin/commands/bots.rb +2 -2
  10. data/bin/commands/channels.rb +31 -31
  11. data/bin/commands/chat.rb +40 -23
  12. data/bin/commands/dnd.rb +8 -8
  13. data/bin/commands/emoji.rb +2 -2
  14. data/bin/commands/files.rb +17 -17
  15. data/bin/commands/files_comments.rb +6 -6
  16. data/bin/commands/groups.rb +36 -35
  17. data/bin/commands/im.rb +13 -13
  18. data/bin/commands/mpim.rb +11 -11
  19. data/bin/commands/oauth.rb +15 -2
  20. data/bin/commands/pins.rb +6 -6
  21. data/bin/commands/reactions.rb +13 -13
  22. data/bin/commands/reminders.rb +10 -10
  23. data/bin/commands/rtm.rb +10 -6
  24. data/bin/commands/search.rb +9 -9
  25. data/bin/commands/stars.rb +8 -8
  26. data/bin/commands/team.rb +10 -10
  27. data/bin/commands/team_profile.rb +2 -2
  28. data/bin/commands/usergroups.rb +16 -16
  29. data/bin/commands/usergroups_users.rb +4 -4
  30. data/bin/commands/users.rb +20 -18
  31. data/bin/commands/users_profile.rb +7 -7
  32. data/lib/slack/real_time/stores/starter.rb +20 -0
  33. data/lib/slack/real_time/stores/store.rb +20 -0
  34. data/lib/slack/version.rb +1 -1
  35. data/lib/slack/web/api/endpoints.rb +2 -0
  36. data/lib/slack/web/api/endpoints/api.rb +1 -1
  37. data/lib/slack/web/api/endpoints/apps_permissions.rb +35 -0
  38. data/lib/slack/web/api/endpoints/auth.rb +2 -2
  39. data/lib/slack/web/api/endpoints/bots.rb +1 -1
  40. data/lib/slack/web/api/endpoints/channels.rb +17 -18
  41. data/lib/slack/web/api/endpoints/chat.rb +67 -30
  42. data/lib/slack/web/api/endpoints/dnd.rb +4 -4
  43. data/lib/slack/web/api/endpoints/emoji.rb +1 -1
  44. data/lib/slack/web/api/endpoints/files.rb +16 -17
  45. data/lib/slack/web/api/endpoints/files_comments.rb +8 -8
  46. data/lib/slack/web/api/endpoints/groups.rb +21 -22
  47. data/lib/slack/web/api/endpoints/im.rb +8 -10
  48. data/lib/slack/web/api/endpoints/mpim.rb +7 -9
  49. data/lib/slack/web/api/endpoints/oauth.rb +23 -2
  50. data/lib/slack/web/api/endpoints/pins.rb +3 -5
  51. data/lib/slack/web/api/endpoints/reactions.rb +14 -16
  52. data/lib/slack/web/api/endpoints/reminders.rb +5 -5
  53. data/lib/slack/web/api/endpoints/rtm.rb +14 -6
  54. data/lib/slack/web/api/endpoints/search.rb +9 -9
  55. data/lib/slack/web/api/endpoints/stars.rb +7 -9
  56. data/lib/slack/web/api/endpoints/team.rb +8 -9
  57. data/lib/slack/web/api/endpoints/team_profile.rb +1 -1
  58. data/lib/slack/web/api/endpoints/usergroups.rb +17 -17
  59. data/lib/slack/web/api/endpoints/usergroups_users.rb +2 -2
  60. data/lib/slack/web/api/endpoints/users.rb +15 -15
  61. data/lib/slack/web/api/endpoints/users_profile.rb +8 -8
  62. data/lib/slack/web/api/patches/chat.3.update-attachments-support.patch +4 -3
  63. data/lib/slack/web/api/patches/chat.4.postEphemeral-attachments-support.patch +17 -0
  64. data/spec/integration/integration_spec.rb +1 -1
  65. data/spec/slack/web/api/endpoints/apps_permissions_spec.rb +15 -0
  66. data/spec/slack/web/api/endpoints/custom_specs/chat_spec.rb +37 -1
  67. data/spec/slack/web/api/endpoints/files_comments_spec.rb +8 -8
  68. data/spec/slack/web/api/endpoints/files_spec.rb +0 -5
  69. data/spec/slack/web/api/endpoints/oauth_spec.rb +11 -0
  70. metadata +7 -2
@@ -6,8 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module Oauth
8
8
  #
9
- # This method allows you to exchange a temporary OAuth code for an API access token.
10
- # This is used as part of the OAuth authentication flow.
9
+ # Exchanges a temporary OAuth code for an API token.
11
10
  #
12
11
  # @option options [Object] :client_id
13
12
  # Issued when you created your application.
@@ -25,6 +24,28 @@ module Slack
25
24
  throw ArgumentError.new('Required arguments :code missing') if options[:code].nil?
26
25
  post('oauth.access', options)
27
26
  end
27
+
28
+ #
29
+ # Exchanges a temporary OAuth verifier code for a workspace token.
30
+ #
31
+ # @option options [Object] :client_id
32
+ # Issued when you created your application.
33
+ # @option options [Object] :client_secret
34
+ # Issued when you created your application.
35
+ # @option options [Object] :code
36
+ # The code param returned via the OAuth callback.
37
+ # @option options [Object] :redirect_uri
38
+ # This must match the originally submitted URI (if one was sent).
39
+ # @option options [Object] :single_channel
40
+ # Request the user to add your app only to a single channel.
41
+ # @see https://api.slack.com/methods/oauth.token
42
+ # @see https://github.com/dblock/slack-api-ref/blob/master/methods/oauth/oauth.token.json
43
+ def oauth_token(options = {})
44
+ throw ArgumentError.new('Required arguments :client_id missing') if options[:client_id].nil?
45
+ throw ArgumentError.new('Required arguments :client_secret missing') if options[:client_secret].nil?
46
+ throw ArgumentError.new('Required arguments :code missing') if options[:code].nil?
47
+ post('oauth.token', options)
48
+ end
28
49
  end
29
50
  end
30
51
  end
@@ -6,8 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module Pins
8
8
  #
9
- # This method pins an item (file, file comment, channel message, or group message) to a particular channel.
10
- # The channel argument is required and one of file, file_comment, or timestamp must also be specified.
9
+ # Pins an item to a channel.
11
10
  #
12
11
  # @option options [channel] :channel
13
12
  # Channel to pin the item in.
@@ -26,7 +25,7 @@ module Slack
26
25
  end
27
26
 
28
27
  #
29
- # This method lists the items pinned to a channel.
28
+ # Lists items pinned to a channel.
30
29
  #
31
30
  # @option options [channel] :channel
32
31
  # Channel to get pinned items for.
@@ -39,8 +38,7 @@ module Slack
39
38
  end
40
39
 
41
40
  #
42
- # This method un-pins an item (file, file comment, channel message, or group message) from a channel.
43
- # The channel argument is required and one of file, file_comment, or timestamp must also be specified.
41
+ # Un-pins an item from a channel.
44
42
  #
45
43
  # @option options [channel] :channel
46
44
  # Channel where the item is pinned to.
@@ -6,17 +6,16 @@ module Slack
6
6
  module Endpoints
7
7
  module Reactions
8
8
  #
9
- # This method adds a reaction (emoji) to an item (file, file comment, channel message, group message, or direct message).
10
- # One of file, file_comment, or the combination of channel and timestamp must be specified.
9
+ # Adds a reaction to an item.
11
10
  #
12
11
  # @option options [Object] :name
13
12
  # Reaction (emoji) name.
13
+ # @option options [channel] :channel
14
+ # Channel where the message to add reaction to was posted.
14
15
  # @option options [file] :file
15
16
  # File to add reaction to.
16
17
  # @option options [Object] :file_comment
17
18
  # File comment to add reaction to.
18
- # @option options [channel] :channel
19
- # Channel where the message to add reaction to was posted.
20
19
  # @option options [Object] :timestamp
21
20
  # Timestamp of the message to add reaction to.
22
21
  # @see https://api.slack.com/methods/reactions.add
@@ -28,18 +27,18 @@ module Slack
28
27
  end
29
28
 
30
29
  #
31
- # This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).
30
+ # Gets reactions for an item.
32
31
  #
32
+ # @option options [channel] :channel
33
+ # Channel where the message to get reactions for was posted.
33
34
  # @option options [file] :file
34
35
  # File to get reactions for.
35
36
  # @option options [Object] :file_comment
36
37
  # File comment to get reactions for.
37
- # @option options [channel] :channel
38
- # Channel where the message to get reactions for was posted.
39
- # @option options [Object] :timestamp
40
- # Timestamp of the message to get reactions for.
41
38
  # @option options [Object] :full
42
39
  # If true always return the complete reaction list.
40
+ # @option options [Object] :timestamp
41
+ # Timestamp of the message to get reactions for.
43
42
  # @see https://api.slack.com/methods/reactions.get
44
43
  # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reactions/reactions.get.json
45
44
  def reactions_get(options = {})
@@ -48,12 +47,12 @@ module Slack
48
47
  end
49
48
 
50
49
  #
51
- # This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.
50
+ # Lists reactions made by a user.
52
51
  #
53
- # @option options [user] :user
54
- # Show reactions made by this user. Defaults to the authed user.
55
52
  # @option options [Object] :full
56
53
  # If true always return the complete reaction list.
54
+ # @option options [user] :user
55
+ # Show reactions made by this user. Defaults to the authed user.
57
56
  # @see https://api.slack.com/methods/reactions.list
58
57
  # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reactions/reactions.list.json
59
58
  def reactions_list(options = {})
@@ -62,17 +61,16 @@ module Slack
62
61
  end
63
62
 
64
63
  #
65
- # This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message).
66
- # One of file, file_comment, or the combination of channel and timestamp must be specified.
64
+ # Removes a reaction from an item.
67
65
  #
68
66
  # @option options [Object] :name
69
67
  # Reaction (emoji) name.
68
+ # @option options [channel] :channel
69
+ # Channel where the message to remove reaction from was posted.
70
70
  # @option options [file] :file
71
71
  # File to remove reaction from.
72
72
  # @option options [Object] :file_comment
73
73
  # File comment to remove reaction from.
74
- # @option options [channel] :channel
75
- # Channel where the message to remove reaction from was posted.
76
74
  # @option options [Object] :timestamp
77
75
  # Timestamp of the message to remove reaction from.
78
76
  # @see https://api.slack.com/methods/reactions.remove
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module Reminders
8
8
  #
9
- # This method creates a reminder.
9
+ # Creates a reminder.
10
10
  #
11
11
  # @option options [Object] :text
12
12
  # The content of the reminder.
@@ -24,7 +24,7 @@ module Slack
24
24
  end
25
25
 
26
26
  #
27
- # This method completes a reminder.
27
+ # Marks a reminder as complete.
28
28
  #
29
29
  # @option options [Object] :reminder
30
30
  # The ID of the reminder to be marked as complete.
@@ -36,7 +36,7 @@ module Slack
36
36
  end
37
37
 
38
38
  #
39
- # This method deletes a reminder.
39
+ # Deletes a reminder.
40
40
  #
41
41
  # @option options [Object] :reminder
42
42
  # The ID of the reminder.
@@ -48,7 +48,7 @@ module Slack
48
48
  end
49
49
 
50
50
  #
51
- # This method returns information about a reminder.
51
+ # Gets information about a reminder.
52
52
  #
53
53
  # @option options [Object] :reminder
54
54
  # The ID of the reminder.
@@ -60,7 +60,7 @@ module Slack
60
60
  end
61
61
 
62
62
  #
63
- # This method lists all reminders created by or for a given user.
63
+ # Lists all reminders created by or for a given user.
64
64
  #
65
65
  # @see https://api.slack.com/methods/reminders.list
66
66
  # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reminders/reminders.list.json
@@ -6,8 +6,12 @@ module Slack
6
6
  module Endpoints
7
7
  module Rtm
8
8
  #
9
- # This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.
9
+ # Starts a Real Time Messaging session.
10
10
  #
11
+ # @option options [Object] :batch_presence_aware
12
+ # Group presence change notices as presence_change_batch events when possible. See batching.
13
+ # @option options [Object] :presence_sub
14
+ # Only deliver presence events when requested by subscription. See presence subscriptions.
11
15
  # @see https://api.slack.com/methods/rtm.connect
12
16
  # @see https://github.com/dblock/slack-api-ref/blob/master/methods/rtm/rtm.connect.json
13
17
  def rtm_connect(options = {})
@@ -15,16 +19,20 @@ module Slack
15
19
  end
16
20
 
17
21
  #
18
- # This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.
22
+ # Starts a Real Time Messaging session.
19
23
  #
20
- # @option options [Object] :simple_latest
21
- # Return timestamp only for latest message object of each channel (improves performance).
22
- # @option options [Object] :no_unreads
23
- # Skip unread counts for each channel (improves performance).
24
+ # @option options [Object] :batch_presence_aware
25
+ # Group presence change notices as presence_change_batch events when possible. See batching.
24
26
  # @option options [Object] :mpim_aware
25
27
  # Returns MPIMs to the client in the API response.
26
28
  # @option options [Object] :no_latest
27
29
  # Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1.
30
+ # @option options [Object] :no_unreads
31
+ # Skip unread counts for each channel (improves performance).
32
+ # @option options [Object] :presence_sub
33
+ # Only deliver presence events when requested by subscription. See presence subscriptions.
34
+ # @option options [Object] :simple_latest
35
+ # Return timestamp only for latest message object of each channel (improves performance).
28
36
  # @see https://api.slack.com/methods/rtm.start
29
37
  # @see https://github.com/dblock/slack-api-ref/blob/master/methods/rtm/rtm.start.json
30
38
  def rtm_start(options = {})
@@ -6,16 +6,16 @@ module Slack
6
6
  module Endpoints
7
7
  module Search
8
8
  #
9
- # This method allows users and applications to search both messages and files in a single call.
9
+ # Searches for messages and files matching a query.
10
10
  #
11
11
  # @option options [Object] :query
12
12
  # Search query. May contains booleans, etc.
13
+ # @option options [Object] :highlight
14
+ # Pass a value of true to enable query highlight markers (see below).
13
15
  # @option options [Object] :sort
14
16
  # Return matches sorted by either score or timestamp.
15
17
  # @option options [Object] :sort_dir
16
18
  # Change sort direction to ascending (asc) or descending (desc).
17
- # @option options [Object] :highlight
18
- # Pass a value of true to enable query highlight markers (see below).
19
19
  # @see https://api.slack.com/methods/search.all
20
20
  # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search/search.all.json
21
21
  def search_all(options = {})
@@ -24,16 +24,16 @@ module Slack
24
24
  end
25
25
 
26
26
  #
27
- # This method returns files matching a search query.
27
+ # Searches for files matching a query.
28
28
  #
29
29
  # @option options [Object] :query
30
30
  # Search query. May contain booleans, etc.
31
+ # @option options [Object] :highlight
32
+ # Pass a value of true to enable query highlight markers (see below).
31
33
  # @option options [Object] :sort
32
34
  # Return matches sorted by either score or timestamp.
33
35
  # @option options [Object] :sort_dir
34
36
  # Change sort direction to ascending (asc) or descending (desc).
35
- # @option options [Object] :highlight
36
- # Pass a value of true to enable query highlight markers (see below).
37
37
  # @see https://api.slack.com/methods/search.files
38
38
  # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search/search.files.json
39
39
  def search_files(options = {})
@@ -42,16 +42,16 @@ module Slack
42
42
  end
43
43
 
44
44
  #
45
- # This method returns messages matching a search query.
45
+ # Searches for messages matching a query.
46
46
  #
47
47
  # @option options [Object] :query
48
48
  # Search query. May contains booleans, etc.
49
+ # @option options [Object] :highlight
50
+ # Pass a value of true to enable query highlight markers (see below).
49
51
  # @option options [Object] :sort
50
52
  # Return matches sorted by either score or timestamp.
51
53
  # @option options [Object] :sort_dir
52
54
  # Change sort direction to ascending (asc) or descending (desc).
53
- # @option options [Object] :highlight
54
- # Pass a value of true to enable query highlight markers (see below).
55
55
  # @see https://api.slack.com/methods/search.messages
56
56
  # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search/search.messages.json
57
57
  def search_messages(options = {})
@@ -6,15 +6,14 @@ module Slack
6
6
  module Endpoints
7
7
  module Stars
8
8
  #
9
- # This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.
10
- # One of file, file_comment, channel, or the combination of channel and timestamp must be specified.
9
+ # Adds a star to an item.
11
10
  #
11
+ # @option options [channel] :channel
12
+ # Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
12
13
  # @option options [file] :file
13
14
  # File to add star to.
14
15
  # @option options [Object] :file_comment
15
16
  # File comment to add star to.
16
- # @option options [channel] :channel
17
- # Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
18
17
  # @option options [Object] :timestamp
19
18
  # Timestamp of the message to add star to.
20
19
  # @see https://api.slack.com/methods/stars.add
@@ -25,7 +24,7 @@ module Slack
25
24
  end
26
25
 
27
26
  #
28
- # This method lists the items starred by the authed user.
27
+ # Lists stars for a user.
29
28
  #
30
29
  # @see https://api.slack.com/methods/stars.list
31
30
  # @see https://github.com/dblock/slack-api-ref/blob/master/methods/stars/stars.list.json
@@ -34,15 +33,14 @@ module Slack
34
33
  end
35
34
 
36
35
  #
37
- # This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.
38
- # One of file, file_comment, channel, or the combination of channel and timestamp must be specified.
36
+ # Removes a star from an item.
39
37
  #
38
+ # @option options [channel] :channel
39
+ # Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).
40
40
  # @option options [file] :file
41
41
  # File to remove star from.
42
42
  # @option options [Object] :file_comment
43
43
  # File comment to remove star from.
44
- # @option options [channel] :channel
45
- # Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).
46
44
  # @option options [Object] :timestamp
47
45
  # Timestamp of the message to remove star from.
48
46
  # @see https://api.slack.com/methods/stars.remove
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module Team
8
8
  #
9
- # This method is used to get the access logs for users on a team.
9
+ # Gets the access logs for the current team.
10
10
  #
11
11
  # @option options [Object] :before
12
12
  # End of time range of logs to include in results (inclusive).
@@ -17,8 +17,7 @@ module Slack
17
17
  end
18
18
 
19
19
  #
20
- # This method lists billable information for each user on the team. Currently this consists solely of whether the user is
21
- # subject to billing per Slack's Fair Billing policy.
20
+ # Gets billable users information for the current team.
22
21
  #
23
22
  # @option options [user] :user
24
23
  # A user to retrieve the billable information for. Defaults to all users.
@@ -30,7 +29,7 @@ module Slack
30
29
  end
31
30
 
32
31
  #
33
- # This method provides information about your team.
32
+ # Gets information about the current team.
34
33
  #
35
34
  # @see https://api.slack.com/methods/team.info
36
35
  # @see https://github.com/dblock/slack-api-ref/blob/master/methods/team/team.info.json
@@ -39,16 +38,16 @@ module Slack
39
38
  end
40
39
 
41
40
  #
42
- # This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins.
41
+ # Gets the integration logs for the current team.
43
42
  #
44
- # @option options [Object] :service_id
45
- # Filter logs to this service. Defaults to all logs.
46
43
  # @option options [Object] :app_id
47
44
  # Filter logs to this Slack app. Defaults to all logs.
48
- # @option options [user] :user
49
- # Filter logs generated by this user's actions. Defaults to all logs.
50
45
  # @option options [Object] :change_type
51
46
  # Filter logs with this change type. Defaults to all logs.
47
+ # @option options [Object] :service_id
48
+ # Filter logs to this service. Defaults to all logs.
49
+ # @option options [user] :user
50
+ # Filter logs generated by this user's actions. Defaults to all logs.
52
51
  # @see https://api.slack.com/methods/team.integrationLogs
53
52
  # @see https://github.com/dblock/slack-api-ref/blob/master/methods/team/team.integrationLogs.json
54
53
  def team_integrationLogs(options = {})
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module TeamProfile
8
8
  #
9
- # This method is used to get the profile field definitions for this team.
9
+ # Retrieve a team's profile.
10
10
  #
11
11
  # @option options [Object] :visibility
12
12
  # Filter by visibility.
@@ -6,16 +6,16 @@ module Slack
6
6
  module Endpoints
7
7
  module Usergroups
8
8
  #
9
- # This method is used to create a User Group.
9
+ # Create a User Group
10
10
  #
11
11
  # @option options [Object] :name
12
12
  # A name for the User Group. Must be unique among User Groups.
13
- # @option options [Object] :handle
14
- # A mention handle. Must be unique among channels, users and User Groups.
15
- # @option options [Object] :description
16
- # A short description of the User Group.
17
13
  # @option options [Object] :channels
18
14
  # A comma separated string of encoded channel IDs for which the User Group uses as a default.
15
+ # @option options [Object] :description
16
+ # A short description of the User Group.
17
+ # @option options [Object] :handle
18
+ # A mention handle. Must be unique among channels, users and User Groups.
19
19
  # @option options [Object] :include_count
20
20
  # Include the number of users in each User Group.
21
21
  # @see https://api.slack.com/methods/usergroups.create
@@ -26,7 +26,7 @@ module Slack
26
26
  end
27
27
 
28
28
  #
29
- # This method disables an existing User Group.
29
+ # Disable an existing User Group
30
30
  #
31
31
  # @option options [Object] :usergroup
32
32
  # The encoded ID of the User Group to disable.
@@ -40,7 +40,7 @@ module Slack
40
40
  end
41
41
 
42
42
  #
43
- # This method enables a User Group which was previously disabled.
43
+ # Enable a User Group
44
44
  #
45
45
  # @option options [Object] :usergroup
46
46
  # The encoded ID of the User Group to enable.
@@ -54,12 +54,12 @@ module Slack
54
54
  end
55
55
 
56
56
  #
57
- # This method returns a list of all User Groups in the team. This can optionally include disabled User Groups.
57
+ # List all User Groups for a team
58
58
  #
59
- # @option options [Object] :include_disabled
60
- # Include disabled User Groups.
61
59
  # @option options [Object] :include_count
62
60
  # Include the number of users in each User Group.
61
+ # @option options [Object] :include_disabled
62
+ # Include disabled User Groups.
63
63
  # @option options [Object] :include_users
64
64
  # Include the list of users for each User Group.
65
65
  # @see https://api.slack.com/methods/usergroups.list
@@ -69,20 +69,20 @@ module Slack
69
69
  end
70
70
 
71
71
  #
72
- # This method updates the properties of an existing User Group.
72
+ # Update an existing User Group
73
73
  #
74
74
  # @option options [Object] :usergroup
75
75
  # The encoded ID of the User Group to update.
76
- # @option options [Object] :name
77
- # A name for the User Group. Must be unique among User Groups.
78
- # @option options [Object] :handle
79
- # A mention handle. Must be unique among channels, users and User Groups.
80
- # @option options [Object] :description
81
- # A short description of the User Group.
82
76
  # @option options [Object] :channels
83
77
  # A comma separated string of encoded channel IDs for which the User Group uses as a default.
78
+ # @option options [Object] :description
79
+ # A short description of the User Group.
80
+ # @option options [Object] :handle
81
+ # A mention handle. Must be unique among channels, users and User Groups.
84
82
  # @option options [Object] :include_count
85
83
  # Include the number of users in the User Group.
84
+ # @option options [Object] :name
85
+ # A name for the User Group. Must be unique among User Groups.
86
86
  # @see https://api.slack.com/methods/usergroups.update
87
87
  # @see https://github.com/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.update.json
88
88
  def usergroups_update(options = {})