slack-ruby-client 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcd1ef609f08b50f10e18a4c6fead723a0479638
-  data.tar.gz: 3740c747309c53870894ff627b5101149881e379
+  metadata.gz: b96448be8f1c835685f93f3393f8920cae201f40
+  data.tar.gz: 425cd9b3c64c3ece99de2ee2fd678b088cee8332
 SHA512:
-  metadata.gz: ff1a0e156c5cd597c7a785dd5c740bea559fb86f83c5955e218a37e4fd827dc7335456f907fbc30ea3d89654c0a4ea154acc3afb3328a014de4a7a9a7877faf5
-  data.tar.gz: 9b62c200399f30be7df84c19da02d52a29585713b7ce0e7cc9ed3b0d97ccc9a19e4f51add07605b7a713988f482ce5f6ed15e27c6b50112718c97e9dfee62778
+  metadata.gz: 1ef45ffaa491253809ea56bbcdff87ca957ac483da23a3233b8167452e7cdf36f071fa94fd1cb123f1dd6eb148d6b590c64fee78d1df0301689d6ca8964d9bc1
+  data.tar.gz: 38041c875f7b29eb12b0345bae2b04664dab1d31d1eda39c408feabff8f3f180112c28be13b4909737474f6c06c70ccb48c3faf1ad2b6acd9384ec4dd6bf97b4

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-04-30 12:02:22 -0400 using RuboCop version 0.35.0.
+# on 2017-09-19 15:04:24 -0400 using RuboCop version 0.35.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 4
 Lint/HandleExceptions:
   Exclude:
     - 'lib/slack-ruby-client.rb'
@@ -20,7 +20,7 @@ Lint/UnusedBlockArgument:
   Exclude:
     - 'lib/slack/messages/formatting.rb'
 
-# Offense count: 14
+# Offense count: 18
 Metrics/AbcSize:
   Max: 44
 
@@ -29,25 +29,30 @@ Metrics/AbcSize:
 Metrics/ClassLength:
   Max: 165
 
-# Offense count: 3
+# Offense count: 4
 Metrics/CyclomaticComplexity:
   Max: 9
 
-# Offense count: 720
+# Offense count: 734
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
-  Max: 288
+  Max: 266
 
-# Offense count: 7
+# Offense count: 9
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 32
 
-# Offense count: 2
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 113
+
+# Offense count: 3
 Metrics/PerceivedComplexity:
   Max: 11
 
-# Offense count: 59
+# Offense count: 64
 # Configuration parameters: Exclude.
 Style/Documentation:
   Enabled: false
@@ -58,12 +63,12 @@ Style/FileName:
   Exclude:
     - 'lib/slack-ruby-client.rb'
 
-# Offense count: 116
+# Offense count: 136
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Enabled: false
 
-# Offense count: 21
+# Offense count: 24
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/MethodName:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### 0.10.0 (9/19/2017)
+
+* [#169](https://github.com/slack-ruby/slack-ruby-client/pull/169): Added [Conversations API](https://api.slack.com/docs/conversations-api) - [@jmanian](https://github.com/jmanian).
+* [#169](https://github.com/slack-ruby/slack-ruby-client/pull/169): Added `include_locale` parameter to several methods (`channels_info`, `groups_info`, `im_open`, `rtm_start`, `users_info`, `users_list`) - [@jmanian](https://github.com/jmanian).
+* [#169](https://github.com/slack-ruby/slack-ruby-client/pull/169): Removed `groups_close` - [@jmanian](https://github.com/jmanian).
+* [#167](https://github.com/slack-ruby/slack-ruby-client/pull/167): Added support for pausing between paginated requests that can cause Slack rate limiting - [@jmanian](https://github.com/jmanian).
+* [#163](https://github.com/slack-ruby/slack-ruby-client/pull/164): Use `OpenSSL::X509::DEFAULT_CERT_DIR` and `OpenSSL::X509::DEFAULT_CERT_FILE` for default ca_cert and ca_file - [@leifcr](https://github.com/leifcr).
+* [#161](https://github.com/slack-ruby/slack-ruby-client/pull/161): Added support for cursor pagination - [@dblock](https://github.com/dblock).
+* [#162](https://github.com/slack-ruby/slack-ruby-client/pull/162): Gracefully close websocket on `Errno::EPIPE` - [@johanoskarsson](https://github.com/johanoskarsson).
+* [#172](https://github.com/slack-ruby/slack-ruby-client/pull/172): Use `rtm.start` when store is a subclass of `Slack::RealTime::Stores::Store` (default) - [@kstole](https://github.com/kstole).
+
 ### 0.9.1 (8/24/2017)
 
 * [#158](https://github.com/slack-ruby/slack-ruby-client/issues/158): Updated to latest slack-api-ref; Updated chat.3.update patch to reflect argument reordering; Added chat.4.postEphemeral patch to apply the attachments JSON fix (whitespace last line of diff matters! ;-) - [@alexagranov](https://github.com/alexagranov).

data/README.md

@@ -18,7 +18,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messa
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.10.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -164,17 +164,19 @@ client = Slack::Web::Client.new(user_agent: 'Slack Ruby Client/1.0')
 
 The following settings are supported.
 
-setting      | description
--------------|-------------------------------------------------------------------------------------------------
-token        | Slack API token.
-user_agent   | User-agent, defaults to _Slack Ruby Client/version_.
-proxy        | Optional HTTP proxy.
-ca_path      | Optional SSL certificates path.
-ca_file      | Optional SSL certificates file.
-endpoint     | Slack endpoint, default is _https://slack.com/api_.
-logger       | Optional `Logger` instance that logs HTTP requests.
-timeout      | Optional open/read timeout in seconds.
-open_timeout | Optional connection open timeout in seconds.
+setting             | description
+--------------------|-------------------------------------------------------------------------------------------------
+token               | Slack API token.
+user_agent          | User-agent, defaults to _Slack Ruby Client/version_.
+proxy               | Optional HTTP proxy.
+ca_path             | Optional SSL certificates path.
+ca_file             | Optional SSL certificates file.
+endpoint            | Slack endpoint, default is _https://slack.com/api_.
+logger              | Optional `Logger` instance that logs HTTP requests.
+timeout             | Optional open/read timeout in seconds.
+open_timeout        | Optional connection open timeout in seconds.
+default_page_size   | Optional page size for paginated requests, default is _100_.
+default_max_retries | Optional number of retries for paginated requests, default is _100_.
 
 You can also pass request options, including `timeout` and `open_timeout` into individual calls.
 
@@ -182,6 +184,32 @@ You can also pass request options, including `timeout` and `open_timeout` into i
 client.channels_list(request: { timeout: 180 })
 ```
 
+#### Pagination Support
+
+The Web client natively supports [cursor pagination](https://api.slack.com/docs/pagination#cursors) for methods that allow it, such as `users_list`. Supply a block and the client will make repeated requests adjusting the value of `cursor` with every response. The default limit is set to 100 and can be adjusted via `Slack::Web::Client.config.default_page_size` or by passing it directly into the API call.
+
+```ruby
+all_members = []
+client.users_list(presence: true, limit: 10) do |response|
+  all_members.concat(response.members)
+end
+all_members # many thousands of team members retrieved 10 at a time
+```
+
+When using cursor pagination the client will automatically pause and then retry the request if it runs into Slack rate limiting. (It will pause according to the `Retry-After` header in the 429 response before retrying the request.) If it receives too many rate-limited responses in a row it will give up and raise an error. The default number of retries is 100 and can be adjusted via `Slack::Web::Client.config.default_max_retries` or by passing it directly into the method as `max_retries`.
+
+You can also proactively avoid rate limiting by adding a pause between every paginated request with the `sleep_interval` parameter, which is given in seconds.
+
+```ruby
+all_members = []
+client.users_list(presence: true, limit: 10, sleep_interval: 5, max_retries: 20) do |response|
+  # pauses for 5 seconds between each request
+  # gives up after 20 consecutive rate-limited responses
+  all_members.concat(response.members)
+end
+all_members # many thousands of team members retrieved 10 at a time
+```
+
 ### RealTime Client
 
 The Real Time Messaging API is a WebSocket-based API that allows you to receive events from Slack in real time and send messages as user.

data/UPGRADING.md

@@ -5,7 +5,7 @@ Upgrading Slack-Ruby-Client
 
 #### Changes in How the RTM Client Connects
 
-The RealTime client now automatically chooses either [rtm.start](https://api.slack.com/methods/rtm.start) or [rtm.connect](https://api.slack.com/methods/rtm.connect) to open a connection. The former retrieves a lot of team information while the latter only serves connection purposes and is newer and preferred, while the latter is required to use the full `Slack::RealTime::Stores::Store` storage class.
+The RealTime client now automatically chooses either [rtm.start](https://api.slack.com/methods/rtm.start) or [rtm.connect](https://api.slack.com/methods/rtm.connect) to open a connection. The `rtm.connect` method is a newer, preferred method, which serves connection purposes and returns some basic team info. The `rtm.start` method additionally returns a lot of data about the team, its channels, and members, and is required to use the full `Slack::RealTime::Stores::Store` storage class.
 
 Prior versions always used `rtm.start`, to restore this behavior, configure `start_method`.
 

data/bin/commands.rb

@@ -6,6 +6,7 @@ require 'commands/auth'
 require 'commands/bots'
 require 'commands/channels'
 require 'commands/chat'
+require 'commands/conversations'
 require 'commands/dnd'
 require 'commands/emoji'
 require 'commands/files_comments'

data/bin/commands/channels.rb

@@ -38,6 +38,7 @@ command 'channels' do |g|
   g.long_desc %( Gets information about a channel. )
   g.command 'info' do |c|
     c.flag 'channel', desc: 'Channel to get info on.'
+    c.flag 'include_locale', desc: 'Set this to true to receive the locale for this channel. Defaults to false.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.channels_info(options))
     end
@@ -85,8 +86,10 @@ command 'channels' do |g|
   g.desc 'Lists all channels in a Slack team.'
   g.long_desc %( Lists all channels in a Slack 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 'exclude_archived', desc: 'Exclude archived channels from the list.'
     c.flag 'exclude_members', desc: 'Exclude the members collection from each channel.'
+    c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.channels_list(options))
     end

data/bin/commands/conversations.rb

@@ -0,0 +1,178 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+desc "Interface with all kinds of conversations the same way, whether they're public or private channels, direct messages, or otherwise."
+command 'conversations' do |g|
+  g.desc 'Archives a conversation.'
+  g.long_desc %( Archives a conversation. )
+  g.command 'archive' do |c|
+    c.flag 'channel', desc: 'ID of conversation to archive.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_archive(options))
+    end
+  end
+
+  g.desc 'Closes a direct message or multi-person direct message.'
+  g.long_desc %( Closes a direct message or multi-person direct message. )
+  g.command 'close' do |c|
+    c.flag 'channel', desc: 'Conversation to close.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_close(options))
+    end
+  end
+
+  g.desc 'Initiates a public or private channel-based conversation'
+  g.long_desc %( Initiates a public or private channel-based conversation )
+  g.command 'create' do |c|
+    c.flag 'name', desc: 'Name of the public or private channel to create.'
+    c.flag 'is_private', desc: 'Create a private channel instead of a public one.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_create(options))
+    end
+  end
+
+  g.desc "Fetches a conversation's history of messages and events."
+  g.long_desc %( Fetches a conversation's history of messages and events. )
+  g.command 'history' do |c|
+    c.flag 'channel', desc: 'Conversation ID to fetch history for.'
+    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 'latest', desc: 'End of time range of messages to include in results.'
+    c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
+    c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_history(options))
+    end
+  end
+
+  g.desc 'Retrieve information about a conversation.'
+  g.long_desc %( Retrieve information about a conversation. )
+  g.command 'info' do |c|
+    c.flag 'channel', desc: 'Conversation ID to learn more about.'
+    c.flag 'include_locale', desc: 'Set this to true to receive the locale for this conversation. Defaults to false.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_info(options))
+    end
+  end
+
+  g.desc 'Invites users to a channel.'
+  g.long_desc %( Invites users to a channel. )
+  g.command 'invite' do |c|
+    c.flag 'channel', desc: 'The ID of the public or private channel to invite user(s) to.'
+    c.flag 'users', desc: 'A comma separated list of user IDs. Up to 30 users may be listed.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_invite(options))
+    end
+  end
+
+  g.desc 'Joins an existing conversation.'
+  g.long_desc %( Joins an existing conversation. )
+  g.command 'join' do |c|
+    c.flag 'channel', desc: 'ID of conversation to join.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_join(options))
+    end
+  end
+
+  g.desc 'Removes a user from a conversation.'
+  g.long_desc %( Removes a user from a conversation. )
+  g.command 'kick' do |c|
+    c.flag 'channel', desc: 'ID of conversation to remove user from.'
+    c.flag 'user', desc: 'User ID to be removed.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_kick(options))
+    end
+  end
+
+  g.desc 'Leaves a conversation.'
+  g.long_desc %( Leaves a conversation. )
+  g.command 'leave' do |c|
+    c.flag 'channel', desc: 'Conversation to leave.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_leave(options))
+    end
+  end
+
+  g.desc 'Lists all channels in a Slack team.'
+  g.long_desc %( Lists all channels in a Slack 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 'exclude_archived', desc: 'Set to true to exclude archived channels from the list.'
+    c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000."
+    c.flag 'types', desc: 'Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_list(options))
+    end
+  end
+
+  g.desc 'Retrieve members of a conversation.'
+  g.long_desc %( Retrieve members of a conversation. )
+  g.command 'members' do |c|
+    c.flag 'channel', desc: 'ID of the conversation to retrieve members for.'
+    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. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_members(options))
+    end
+  end
+
+  g.desc 'Opens or resumes a direct message or multi-person direct message.'
+  g.long_desc %( Opens or resumes a direct message or multi-person direct message. )
+  g.command 'open' do |c|
+    c.flag 'channel', desc: "Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead."
+    c.flag 'return_im', desc: 'Boolean, indicates you want the full IM channel definition in the response.'
+    c.flag 'users', desc: 'Comma separated lists of users. If only one user is included, this creates a 1:1 DM.  The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_open(options))
+    end
+  end
+
+  g.desc 'Renames a conversation.'
+  g.long_desc %( Renames a conversation. )
+  g.command 'rename' do |c|
+    c.flag 'channel', desc: 'ID of conversation to rename.'
+    c.flag 'name', desc: 'New name for conversation.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_rename(options))
+    end
+  end
+
+  g.desc 'Retrieve a thread of messages posted to a conversation'
+  g.long_desc %( Retrieve a thread of messages posted to a conversation )
+  g.command 'replies' do |c|
+    c.flag 'channel', desc: 'Conversation ID to fetch thread from.'
+    c.flag 'ts', desc: "Unique identifier of a thread's parent message."
+    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. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_replies(options))
+    end
+  end
+
+  g.desc 'Sets the purpose for a conversation.'
+  g.long_desc %( Sets the purpose for a conversation. )
+  g.command 'setPurpose' do |c|
+    c.flag 'channel', desc: 'Conversation to set the purpose of.'
+    c.flag 'purpose', desc: 'A new, specialer purpose.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_setPurpose(options))
+    end
+  end
+
+  g.desc 'Sets the topic for a conversation.'
+  g.long_desc %( Sets the topic for a conversation. )
+  g.command 'setTopic' do |c|
+    c.flag 'channel', desc: 'Conversation to set the topic of.'
+    c.flag 'topic', desc: 'The new topic string. Does not support formatting or linkification.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_setTopic(options))
+    end
+  end
+
+  g.desc 'Reverses conversation archival.'
+  g.long_desc %( Reverses conversation archival. )
+  g.command 'unarchive' do |c|
+    c.flag 'channel', desc: 'ID of conversation to unarchive.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.conversations_unarchive(options))
+    end
+  end
+end

data/bin/commands/groups.rb

@@ -11,15 +11,6 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'Closes a private channel.'
-  g.long_desc %( Closes a private channel. )
-  g.command 'close' do |c|
-    c.flag 'channel', desc: 'Private channel to close.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_close(options))
-    end
-  end
-
   g.desc 'Creates a private channel.'
   g.long_desc %( Creates a private channel. )
   g.command 'create' do |c|
@@ -56,6 +47,7 @@ command 'groups' do |g|
   g.long_desc %( Gets information about a private channel. )
   g.command 'info' do |c|
     c.flag 'channel', desc: 'Private channel to get info on.'
+    c.flag 'include_locale', desc: 'Set this to true to receive the locale for this group. Defaults to false.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.groups_info(options))
     end

data/bin/commands/im.rb

@@ -27,6 +27,8 @@ command 'im' do |g|
   g.desc 'Lists direct message channels for the calling user.'
   g.long_desc %( Lists direct message channels for the calling user. )
   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. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.im_list(options))
     end
@@ -46,6 +48,7 @@ command 'im' do |g|
   g.long_desc %( Opens a direct message channel. )
   g.command 'open' do |c|
     c.flag 'user', desc: 'User to open a direct message channel with.'
+    c.flag 'include_locale', desc: 'Set this to true to receive the locale for this im. Defaults to false.'
     c.flag 'return_im', desc: 'Boolean, indicates you want the full IM channel definition in the response.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.im_open(options))

data/bin/commands/rtm.rb

@@ -16,6 +16,7 @@ command 'rtm' do |g|
   g.long_desc %( Starts a Real Time Messaging session. )
   g.command 'start' do |c|
     c.flag 'batch_presence_aware', desc: 'Group presence change notices as presence_change_batch events when possible. See batching.'
+    c.flag 'include_locale', desc: 'Set this to true to receive the locale for users and channels. Defaults to false.'
     c.flag 'mpim_aware', desc: 'Returns MPIMs to the client in the API response.'
     c.flag 'no_latest', desc: 'Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1.'
     c.flag 'no_unreads', desc: 'Skip unread counts for each channel (improves performance).'

data/bin/commands/users.rb

@@ -31,6 +31,7 @@ command 'users' do |g|
   g.long_desc %( Gets information about a user. )
   g.command 'info' do |c|
     c.flag 'user', desc: 'User to get info on.'
+    c.flag 'include_locale', desc: 'Set this to true to receive the locale for this user. Defaults to false.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_info(options))
     end
@@ -39,7 +40,8 @@ command 'users' do |g|
   g.desc 'Lists all users in a Slack team.'
   g.long_desc %( Lists all users in a Slack 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 '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 'include_locale', desc: 'Set this to true to receive the locale for users. Defaults to false.'
     c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
     c.flag 'presence', desc: 'Whether to include presence data in the output. Setting this to false improves performance, especially with large teams.'
     c.action do |_global_options, options, _args|