slack-ruby-client 0.14.6 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/FUNDING.yml +1 -0
- data/.rubocop.yml +15 -3
- data/.rubocop_todo.yml +110 -38
- data/.travis.yml +2 -5
- data/CHANGELOG.md +42 -0
- data/CONTRIBUTING.md +19 -8
- data/Dangerfile +1 -1
- data/Gemfile +1 -2
- data/LICENSE.md +1 -1
- data/README.md +38 -36
- data/RELEASING.md +1 -1
- data/UPGRADING.md +62 -2
- data/bin/commands/admin_analytics.rb +16 -0
- data/bin/commands/admin_apps.rb +26 -2
- data/bin/commands/admin_apps_requests.rb +1 -0
- data/bin/commands/admin_auth_policy.rb +39 -0
- data/bin/commands/admin_barriers.rb +47 -0
- data/bin/commands/admin_conversations.rb +155 -3
- data/bin/commands/admin_conversations_ekm.rb +17 -0
- data/bin/commands/admin_conversations_restrictAccess.rb +37 -0
- data/bin/commands/admin_conversations_whitelist.rb +37 -0
- data/bin/commands/admin_emoji.rb +1 -1
- data/bin/commands/admin_teams.rb +1 -1
- data/bin/commands/admin_usergroups.rb +48 -0
- data/bin/commands/admin_users.rb +3 -2
- data/bin/commands/admin_users_session.rb +62 -0
- data/bin/commands/api.rb +0 -1
- data/bin/commands/apps_connections.rb +13 -0
- data/bin/commands/apps_event_authorizations.rb +16 -0
- data/bin/commands/apps_manifest.rb +51 -0
- data/bin/commands/auth_teams.rb +16 -0
- data/bin/commands/bots.rb +1 -0
- data/bin/commands/calls.rb +52 -0
- data/bin/commands/calls_participants.rb +25 -0
- data/bin/commands/channels.rb +1 -155
- data/bin/commands/chat.rb +17 -12
- data/bin/commands/chat_scheduledMessages.rb +1 -0
- data/bin/commands/conversations.rb +71 -3
- data/bin/commands/dnd.rb +2 -0
- data/bin/commands/files.rb +6 -4
- data/bin/commands/files_remote.rb +2 -2
- data/bin/commands/groups.rb +1 -162
- data/bin/commands/im.rb +1 -63
- data/bin/commands/migration.rb +1 -0
- data/bin/commands/mpim.rb +1 -61
- data/bin/commands/oauth.rb +0 -13
- data/bin/commands/oauth_v2.rb +13 -1
- data/bin/commands/openid_connect.rb +27 -0
- data/bin/commands/pins.rb +2 -4
- data/bin/commands/reactions.rb +1 -0
- data/bin/commands/reminders.rb +6 -0
- data/bin/commands/rtm.rb +2 -2
- data/bin/commands/search.rb +4 -0
- data/bin/commands/stars.rb +7 -6
- data/bin/commands/team.rb +3 -0
- data/bin/commands/team_billing.rb +13 -0
- data/bin/commands/team_preferences.rb +13 -0
- data/bin/commands/tooling_tokens.rb +14 -0
- data/bin/commands/usergroups.rb +5 -0
- data/bin/commands/usergroups_users.rb +2 -0
- data/bin/commands/users.rb +4 -2
- data/bin/commands/users_profile.rb +5 -5
- data/bin/commands/views.rb +2 -2
- data/bin/commands/workflows.rb +38 -0
- data/bin/commands.rb +17 -8
- data/lib/slack/config.rb +1 -2
- data/lib/slack/events/request.rb +10 -4
- data/lib/slack/messages/message.rb +0 -4
- data/lib/slack/real_time/client.rb +6 -6
- data/lib/slack/real_time/concurrency/async.rb +7 -11
- data/lib/slack/real_time/concurrency.rb +0 -2
- data/lib/slack/real_time/config.rb +5 -14
- data/lib/slack/real_time/models/base.rb +0 -4
- data/lib/slack/real_time/socket.rb +3 -4
- data/lib/slack/real_time/stores/base.rb +4 -7
- data/lib/slack/real_time/stores/starter.rb +6 -3
- data/lib/slack/real_time/stores/store.rb +5 -0
- data/lib/slack/version.rb +1 -1
- data/lib/slack/web/api/endpoints/admin_analytics.rb +28 -0
- data/lib/slack/web/api/endpoints/admin_apps.rb +42 -6
- data/lib/slack/web/api/endpoints/admin_apps_approved.rb +2 -2
- data/lib/slack/web/api/endpoints/admin_apps_requests.rb +4 -2
- data/lib/slack/web/api/endpoints/admin_apps_restricted.rb +2 -2
- data/lib/slack/web/api/endpoints/admin_auth_policy.rb +72 -0
- data/lib/slack/web/api/endpoints/admin_barriers.rb +82 -0
- data/lib/slack/web/api/endpoints/admin_conversations.rb +234 -4
- data/lib/slack/web/api/endpoints/admin_conversations_ekm.rb +35 -0
- data/lib/slack/web/api/endpoints/admin_conversations_restrictAccess.rb +61 -0
- data/lib/slack/web/api/endpoints/admin_conversations_whitelist.rb +64 -0
- data/lib/slack/web/api/endpoints/admin_emoji.rb +10 -10
- data/lib/slack/web/api/endpoints/admin_inviteRequests.rb +7 -7
- data/lib/slack/web/api/endpoints/admin_inviteRequests_approved.rb +3 -3
- data/lib/slack/web/api/endpoints/admin_inviteRequests_denied.rb +2 -2
- data/lib/slack/web/api/endpoints/admin_teams.rb +7 -7
- data/lib/slack/web/api/endpoints/admin_teams_admins.rb +2 -2
- data/lib/slack/web/api/endpoints/admin_teams_owners.rb +2 -2
- data/lib/slack/web/api/endpoints/admin_teams_settings.rb +5 -5
- data/lib/slack/web/api/endpoints/admin_usergroups.rb +77 -0
- data/lib/slack/web/api/endpoints/admin_users.rb +23 -23
- data/lib/slack/web/api/endpoints/admin_users_session.rb +97 -3
- data/lib/slack/web/api/endpoints/api.rb +1 -3
- data/lib/slack/web/api/endpoints/apps.rb +2 -2
- data/lib/slack/web/api/endpoints/apps_connections.rb +21 -0
- data/lib/slack/web/api/endpoints/apps_event_authorizations.rb +34 -0
- data/lib/slack/web/api/endpoints/apps_manifest.rb +75 -0
- data/lib/slack/web/api/endpoints/auth.rb +1 -1
- data/lib/slack/web/api/endpoints/auth_teams.rb +33 -0
- data/lib/slack/web/api/endpoints/bots.rb +3 -1
- data/lib/slack/web/api/endpoints/calls.rb +83 -0
- data/lib/slack/web/api/endpoints/calls_participants.rb +42 -0
- data/lib/slack/web/api/endpoints/channels.rb +1 -245
- data/lib/slack/web/api/endpoints/chat.rb +76 -66
- data/lib/slack/web/api/endpoints/chat_scheduledMessages.rb +5 -3
- data/lib/slack/web/api/endpoints/conversations.rb +149 -41
- data/lib/slack/web/api/endpoints/dialog.rb +2 -2
- data/lib/slack/web/api/endpoints/dnd.rb +6 -3
- data/lib/slack/web/api/endpoints/files.rb +21 -17
- data/lib/slack/web/api/endpoints/files_comments.rb +1 -1
- data/lib/slack/web/api/endpoints/files_remote.rb +23 -23
- data/lib/slack/web/api/endpoints/groups.rb +0 -253
- data/lib/slack/web/api/endpoints/im.rb +0 -101
- data/lib/slack/web/api/endpoints/migration.rb +4 -2
- data/lib/slack/web/api/endpoints/mpim.rb +0 -96
- data/lib/slack/web/api/endpoints/oauth.rb +5 -30
- data/lib/slack/web/api/endpoints/oauth_v2.rb +24 -6
- data/lib/slack/web/api/endpoints/openid_connect.rb +42 -0
- data/lib/slack/web/api/endpoints/pins.rb +7 -12
- data/lib/slack/web/api/endpoints/reactions.rb +16 -14
- data/lib/slack/web/api/endpoints/reminders.rb +17 -5
- data/lib/slack/web/api/endpoints/rtm.rb +10 -10
- data/lib/slack/web/api/endpoints/search.rb +27 -13
- data/lib/slack/web/api/endpoints/stars.rb +13 -11
- data/lib/slack/web/api/endpoints/team.rb +11 -5
- data/lib/slack/web/api/endpoints/team_billing.rb +21 -0
- data/lib/slack/web/api/endpoints/team_preferences.rb +21 -0
- data/lib/slack/web/api/endpoints/team_profile.rb +1 -1
- data/lib/slack/web/api/endpoints/tooling_tokens.rb +24 -0
- data/lib/slack/web/api/endpoints/usergroups.rb +26 -16
- data/lib/slack/web/api/endpoints/usergroups_users.rb +9 -5
- data/lib/slack/web/api/endpoints/users.rb +20 -18
- data/lib/slack/web/api/endpoints/users_profile.rb +7 -7
- data/lib/slack/web/api/endpoints/views.rb +13 -13
- data/lib/slack/web/api/endpoints/workflows.rb +61 -0
- data/lib/slack/web/api/endpoints.rb +35 -18
- data/lib/slack/web/api/errors/server_error.rb +37 -0
- data/lib/slack/web/api/errors/too_many_requests_error.rb +1 -4
- data/lib/slack/web/api/errors.rb +486 -12
- data/lib/slack/web/api/mixins/{channels.id.rb → conversations.id.rb} +3 -5
- data/lib/slack/web/api/mixins/ids.id.rb +3 -5
- data/lib/slack/web/api/mixins/users.id.rb +1 -3
- data/lib/slack/web/api/mixins.rb +1 -2
- data/lib/slack/web/api/patches/{chat.6.block-kit-support.patch → chat.1.patch} +25 -24
- data/lib/slack/web/api/templates/endpoints.erb +1 -2
- data/lib/slack/web/api/templates/method.erb +4 -1
- data/lib/slack/web/api/templates/method_spec.erb +1 -1
- data/lib/slack/web/config.rb +2 -0
- data/lib/slack/web/faraday/connection.rb +23 -20
- data/lib/slack/web/faraday/request.rb +2 -1
- data/lib/slack/web/faraday/response/raise_error.rb +12 -1
- data/lib/slack/web/faraday/response/wrap_error.rb +24 -0
- data/lib/slack/web/pagination/cursor.rb +3 -7
- data/lib/slack-ruby-client.rb +4 -4
- data/lib/tasks/web.rake +11 -3
- data/slack-ruby-client.gemspec +6 -7
- data/spec/fixtures/slack/web/429_error.yml +50 -54
- data/spec/fixtures/slack/web/auth_test_error.yml +51 -18
- data/spec/fixtures/slack/web/auth_test_success.yml +50 -26
- data/spec/fixtures/slack/web/conversations_info.yml +167 -0
- data/spec/fixtures/slack/web/conversations_setTopic.yml +84 -0
- data/spec/fixtures/slack/web/conversations_setTopic_one_page.yml +172 -0
- data/spec/fixtures/slack/web/conversations_setTopic_paginated.yml +253 -0
- data/spec/fixtures/slack/web/paginated_users_list.yml +501 -69
- data/spec/fixtures/slack/web/rtm_connect.yml +267 -30
- data/spec/fixtures/slack/web/rtm_start.yml +771 -60
- data/spec/fixtures/slack/web/users_info.yml +153 -69
- data/spec/fixtures/slack/web/users_list.yml +102 -41
- data/spec/fixtures/slack/web/views_open_error.yml +49 -42
- data/spec/slack/events/request_spec.rb +13 -8
- data/spec/slack/real_time/client_spec.rb +35 -22
- data/spec/slack/real_time/concurrency/with_concurrency_spec.rb +10 -0
- data/spec/slack/real_time/concurrency/without_concurrency_spec.rb +10 -0
- data/spec/slack/real_time/event_handlers/bot_spec.rb +1 -1
- data/spec/slack/real_time/event_handlers/channel_spec.rb +1 -1
- data/spec/slack/real_time/event_handlers/im_spec.rb +5 -5
- data/spec/slack/real_time/event_handlers/user_spec.rb +2 -2
- data/spec/slack/real_time/rtm_connect_spec.rb +1 -1
- data/spec/slack/real_time/rtm_start_spec.rb +1 -1
- data/spec/slack/slack_spec.rb +3 -1
- data/spec/slack/web/api/endpoints/admin_analytics_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/admin_apps_spec.rb +10 -0
- data/spec/slack/web/api/endpoints/admin_auth_policy_spec.rb +35 -0
- data/spec/slack/web/api/endpoints/admin_barriers_spec.rb +38 -0
- data/spec/slack/web/api/endpoints/{apps_permissions_scopes_spec.rb → admin_conversations_ekm_spec.rb} +1 -1
- data/spec/slack/web/api/endpoints/admin_conversations_restrictAccess_spec.rb +32 -0
- data/spec/slack/web/api/endpoints/admin_conversations_spec.rb +85 -0
- data/spec/slack/web/api/endpoints/admin_emoji_spec.rb +6 -6
- data/spec/slack/web/api/endpoints/admin_teams_settings_spec.rb +10 -10
- data/spec/slack/web/api/endpoints/admin_teams_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/admin_usergroups_spec.rb +37 -0
- data/spec/slack/web/api/endpoints/admin_users_session_spec.rb +28 -0
- data/spec/slack/web/api/endpoints/admin_users_spec.rb +15 -23
- data/spec/slack/web/api/endpoints/{apps_permissions_resources_spec.rb → apps_connections_spec.rb} +1 -1
- data/spec/slack/web/api/endpoints/apps_event_authorizations_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/apps_manifest_spec.rb +36 -0
- data/spec/slack/web/api/endpoints/apps_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/auth_teams_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/calls_participants_spec.rb +24 -0
- data/spec/slack/web/api/endpoints/calls_spec.rb +31 -0
- data/spec/slack/web/api/endpoints/custom_specs/auth_spec.rb +4 -6
- data/spec/slack/web/api/endpoints/custom_specs/conversations_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/custom_specs/users_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/dnd_spec.rb +0 -5
- data/spec/slack/web/api/endpoints/files_comments_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/files_remote_spec.rb +3 -3
- data/spec/slack/web/api/endpoints/files_spec.rb +4 -4
- data/spec/slack/web/api/endpoints/oauth_spec.rb +0 -22
- data/spec/slack/web/api/endpoints/oauth_v2_spec.rb +6 -3
- data/spec/slack/web/api/endpoints/openid_connect_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/pins_spec.rb +1 -4
- data/spec/slack/web/api/endpoints/reactions_spec.rb +3 -3
- data/spec/slack/web/api/endpoints/reminders_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/team_billing_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/team_preferences_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/tooling_tokens_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/usergroups_users_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/workflows_spec.rb +26 -0
- data/spec/slack/web/api/error_spec.rb +5 -7
- data/spec/slack/web/api/errors/slack_error_spec.rb +21 -26
- data/spec/slack/web/api/mixins/conversations_list_spec.rb +21 -0
- data/spec/slack/web/api/mixins/{channels_spec.rb → conversations_spec.rb} +8 -8
- data/spec/slack/web/api/mixins/users_spec.rb +1 -1
- data/spec/slack/web/api/pagination/cursor_spec.rb +1 -3
- data/spec/slack/web/client_spec.rb +123 -1
- data/spec/slack/web/faraday/request_spec.rb +80 -0
- data/spec/slack/web/faraday/response/raise_error_spec.rb +8 -6
- data/spec/spec_helper.rb +1 -1
- data/spec/support/real_time/connected_client.rb +1 -7
- data/spec/support/vcr.rb +36 -1
- metadata +95 -173
- data/examples/hi_real_time/Gemfile +0 -6
- data/examples/hi_real_time/hi.gif +0 -0
- data/examples/hi_real_time/hi.rb +0 -41
- data/examples/hi_real_time_async_celluloid/Gemfile +0 -7
- data/examples/hi_real_time_async_celluloid/Procfile +0 -2
- data/examples/hi_real_time_async_celluloid/hi.rb +0 -39
- data/examples/hi_real_time_async_eventmachine/Gemfile +0 -7
- data/examples/hi_real_time_async_eventmachine/Procfile +0 -2
- data/examples/hi_real_time_async_eventmachine/hi.rb +0 -39
- data/lib/slack/real_time/concurrency/celluloid.rb +0 -142
- data/lib/slack/real_time/concurrency/eventmachine.rb +0 -85
- data/lib/slack/web/api/mixins/channels.id.json +0 -20
- data/lib/slack/web/api/mixins/groups.id.json +0 -20
- data/lib/slack/web/api/mixins/groups.id.rb +0 -27
- data/lib/slack/web/api/patches/chat.1.text-attachments-required.patch +0 -13
- data/lib/slack/web/api/patches/chat.2.attachments-json.patch +0 -17
- data/lib/slack/web/api/patches/chat.3.update-attachments-support.patch +0 -21
- data/lib/slack/web/api/patches/chat.4.postEphemeral-attachments-support.patch +0 -17
- data/lib/slack/web/api/patches/chat.5.postEphemeral-text-or-attachments.patch +0 -15
- data/spec/fixtures/slack/web/503_error.yml +0 -14
- data/spec/fixtures/slack/web/channels_info.yml +0 -46
- data/spec/fixtures/slack/web/groups_info.yml +0 -43
- data/spec/slack/real_time/concurrency/celluloid_spec.rb +0 -116
- data/spec/slack/real_time/concurrency/eventmachine_spec.rb +0 -57
- data/spec/slack/web/api/endpoints/apps_permissions_spec.rb +0 -16
- data/spec/slack/web/api/endpoints/apps_permissions_users_spec.rb +0 -19
- data/spec/slack/web/api/endpoints/conversations_spec.rb +0 -101
- data/spec/slack/web/api/endpoints/custom_specs/channels_spec.rb +0 -13
- data/spec/slack/web/api/endpoints/custom_specs/groups_spec.rb +0 -13
- data/spec/slack/web/api/endpoints/im_spec.rb +0 -39
- data/spec/slack/web/api/endpoints/mpim_spec.rb +0 -39
- data/spec/slack/web/api/endpoints/views_spec.rb +0 -29
- data/spec/slack/web/api/errors/service_unavailable_spec.rb +0 -17
- data/spec/slack/web/api/mixins/groups_spec.rb +0 -43
data/UPGRADING.md
CHANGED
@@ -1,6 +1,68 @@
|
|
1
1
|
Upgrading Slack-Ruby-Client
|
2
2
|
===========================
|
3
3
|
|
4
|
+
### Upgrading to >= 1.0.0
|
5
|
+
|
6
|
+
#### Deprecated Methods
|
7
|
+
|
8
|
+
Slack has deprecated all `channel` and `group` methods, which have been removed from the library.
|
9
|
+
|
10
|
+
See [this announcement from Slack](https://api.slack.com/changelog/2020-01-deprecating-antecedents-to-the-conversations-api) for details.
|
11
|
+
|
12
|
+
#### Error Handling
|
13
|
+
|
14
|
+
As of 1.0.0 `Slack::Web::Api::Errors::ServerError` and its subclasses (introduced in 0.16.0) no longer extend `Slack::Web::Api::Errors::InternalError` or its parent `Slack::Web::Api::Errors::SlackError`. If you are rescuing `SlackError` or `InternalError` with the intention of including `ServerError` and its subclasses you should adjust your code to explicitly rescue `Slack::Web::Api::Errors::ServerError`.
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
# Before
|
18
|
+
begin
|
19
|
+
client.auth_test
|
20
|
+
rescue Slack::Web::Api::Errors::SlackError
|
21
|
+
# Includes all server errors
|
22
|
+
end
|
23
|
+
|
24
|
+
# After
|
25
|
+
begin
|
26
|
+
client.auth_test
|
27
|
+
rescue Slack::Web::Api::Errors::SlackError, Slack::Web::Api::Errors::ServerError
|
28
|
+
# Need to rescue the server errors separately from SlackError
|
29
|
+
end
|
30
|
+
```
|
31
|
+
|
32
|
+
Additionally the `initialize` method for `ParsingError`, `TimeoutError`, and `UnavailableError` have changed from `new(message, response)` to `new(response)`. The `message` is now built into the definition of these classes. If you are instantiating or raising these errors in your code (perhaps in tests) you will need to update your code.
|
33
|
+
|
34
|
+
```ruby
|
35
|
+
# Before
|
36
|
+
error = Slack::Web::Api::Errors::TimeoutError.new('timeout_error', response)
|
37
|
+
error.message
|
38
|
+
# => 'timeout_error'
|
39
|
+
|
40
|
+
# After
|
41
|
+
error = Slack::Web::Api::Errors::TimeoutError.new(response)
|
42
|
+
error.message
|
43
|
+
# => 'timeout_error'
|
44
|
+
```
|
45
|
+
|
46
|
+
### Upgrading to >= 0.16.0
|
47
|
+
|
48
|
+
#### Removed Celluloid and Faye-Websocket Concurrency Support
|
49
|
+
|
50
|
+
Concurrency support for `celluloid-io` and `faye-websocket` has been removed. If you are running a RealTime bot on Celluloid or Faye, you must upgrade to `async-websocket`. Please note that RealTime bots are deprecated by Slack, and we generally recommend you [migrate your classic, RealTime bot, to granular permissions](https://code.dblock.org/2020/11/30/migrating-classic-slack-ruby-bots-to-granular-permissions.html).
|
51
|
+
|
52
|
+
See [#338](https://github.com/slack-ruby/slack-ruby-client/issues/338) for more information.
|
53
|
+
|
54
|
+
#### Error Handling
|
55
|
+
|
56
|
+
As of 0.16.0 `Faraday::Error` exceptions sans `Faraday::ClientError` are wrapped into `Slack::Web::Api::Errors::ServerError`, so if you're rescuing `Faraday::Error` — you should adjust your code to use `Slack::Web::Api::Errors::ServerError` and use `exception.cause` if underlying `Faraday::Error` is needed.
|
57
|
+
|
58
|
+
See [README#other-errors](README.md#other-errors) and [#350](https://github.com/slack-ruby/slack-ruby-client/pull/350) for more information.
|
59
|
+
|
60
|
+
### Upgrading to >= 0.15.0
|
61
|
+
|
62
|
+
As of 0.15.0, `activesupport` is no longer required. Add `gem 'activesupport'` to your Gemfile if you required ActiveSupport via this library.
|
63
|
+
|
64
|
+
See [#325](https://github.com/slack-ruby/slack-ruby-client/pull/325) for more information.
|
65
|
+
|
4
66
|
### Upgrading to >= 0.14.0
|
5
67
|
|
6
68
|
If you are using async-websocket, lock down its version to 0.8.0 as newer versions are currently incompatible.
|
@@ -124,5 +186,3 @@ gem 'celluloid-io'
|
|
124
186
|
When in doubt, use `faye-websocket`.
|
125
187
|
|
126
188
|
See [#5](https://github.com/slack-ruby/slack-ruby-client/issues/5) for more information.
|
127
|
-
|
128
|
-
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminAnalytics methods.'
|
5
|
+
command 'admin_analytics' do |g|
|
6
|
+
g.desc 'Retrieve analytics data for a given date, presented as a compressed JSON file'
|
7
|
+
g.long_desc %( Retrieve analytics data for a given date, presented as a compressed JSON file )
|
8
|
+
g.command 'getFile' do |c|
|
9
|
+
c.flag 'type', desc: 'The type of analytics to retrieve. The options are currently limited to member (for grid member analytics) and public_channel (for public channel analytics).'
|
10
|
+
c.flag 'date', desc: 'Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC.'
|
11
|
+
c.flag 'metadata_only', desc: 'Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.'
|
12
|
+
c.action do |_global_options, options, _args|
|
13
|
+
puts JSON.dump($client.admin_analytics_getFile(options))
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
data/bin/commands/admin_apps.rb
CHANGED
@@ -7,21 +7,45 @@ command 'admin_apps' do |g|
|
|
7
7
|
g.long_desc %( Approve an app for installation on a workspace. )
|
8
8
|
g.command 'approve' do |c|
|
9
9
|
c.flag 'app_id', desc: 'The id of the app to approve.'
|
10
|
+
c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
|
10
11
|
c.flag 'request_id', desc: 'The id of the request to approve.'
|
11
|
-
c.flag 'team_id', desc: '.'
|
12
|
+
c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
|
12
13
|
c.action do |_global_options, options, _args|
|
13
14
|
puts JSON.dump($client.admin_apps_approve(options))
|
14
15
|
end
|
15
16
|
end
|
16
17
|
|
18
|
+
g.desc 'Clear an app resolution'
|
19
|
+
g.long_desc %( Clear an app resolution )
|
20
|
+
g.command 'clearResolution' do |c|
|
21
|
+
c.flag 'app_id', desc: 'The id of the app whose resolution you want to clear/undo.'
|
22
|
+
c.flag 'enterprise_id', desc: 'The enterprise to clear the app resolution from.'
|
23
|
+
c.flag 'team_id', desc: 'The workspace to clear the app resolution from.'
|
24
|
+
c.action do |_global_options, options, _args|
|
25
|
+
puts JSON.dump($client.admin_apps_clearResolution(options))
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
17
29
|
g.desc 'Restrict an app for installation on a workspace.'
|
18
30
|
g.long_desc %( Restrict an app for installation on a workspace. )
|
19
31
|
g.command 'restrict' do |c|
|
20
32
|
c.flag 'app_id', desc: 'The id of the app to restrict.'
|
33
|
+
c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
|
21
34
|
c.flag 'request_id', desc: 'The id of the request to restrict.'
|
22
|
-
c.flag 'team_id', desc: '.'
|
35
|
+
c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
|
23
36
|
c.action do |_global_options, options, _args|
|
24
37
|
puts JSON.dump($client.admin_apps_restrict(options))
|
25
38
|
end
|
26
39
|
end
|
40
|
+
|
41
|
+
g.desc 'Uninstall an app from one or many workspaces, or an entire enterprise organization.'
|
42
|
+
g.long_desc %( Uninstall an app from one or many workspaces, or an entire enterprise organization. )
|
43
|
+
g.command 'uninstall' do |c|
|
44
|
+
c.flag 'app_id', desc: 'The ID of the app to uninstall.'
|
45
|
+
c.flag 'enterprise_id', desc: 'The enterprise to completely uninstall the application from (across all workspaces). With an org-level token, this or team_ids is required.'
|
46
|
+
c.flag 'team_ids', desc: 'IDs of the teams to uninstall from (max 100). With an org-level token, this or enterprise_id is required.'
|
47
|
+
c.action do |_global_options, options, _args|
|
48
|
+
puts JSON.dump($client.admin_apps_uninstall(options))
|
49
|
+
end
|
50
|
+
end
|
27
51
|
end
|
@@ -7,6 +7,7 @@ command 'admin_apps_requests' do |g|
|
|
7
7
|
g.long_desc %( List app requests for a team/workspace. )
|
8
8
|
g.command 'list' do |c|
|
9
9
|
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
|
10
|
+
c.flag 'enterprise_id', desc: '.'
|
10
11
|
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
|
11
12
|
c.flag 'team_id', desc: '.'
|
12
13
|
c.action do |_global_options, options, _args|
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminAuthPolicy methods.'
|
5
|
+
command 'admin_auth_policy' do |g|
|
6
|
+
g.desc 'Assign entities to a particular authentication policy.'
|
7
|
+
g.long_desc %( Assign entities to a particular authentication policy. )
|
8
|
+
g.command 'assignEntities' do |c|
|
9
|
+
c.flag 'entity_ids', desc: 'Array of IDs to assign to the policy.'
|
10
|
+
c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
|
11
|
+
c.flag 'policy_name', desc: 'The name of the authentication policy to assign the entities to. Currently, email_password is the only policy that may be used with this method.'
|
12
|
+
c.action do |_global_options, options, _args|
|
13
|
+
puts JSON.dump($client.admin_auth_policy_assignEntities(options))
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
g.desc 'Fetch all the entities assigned to a particular authentication policy by name.'
|
18
|
+
g.long_desc %( Fetch all the entities assigned to a particular authentication policy by name. )
|
19
|
+
g.command 'getEntities' do |c|
|
20
|
+
c.flag 'policy_name', desc: 'The name of the policy to fetch entities for. Currently, email_password is the only policy that may be used with this method.'
|
21
|
+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
|
22
|
+
c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
|
23
|
+
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 and 1000, both inclusive.'
|
24
|
+
c.action do |_global_options, options, _args|
|
25
|
+
puts JSON.dump($client.admin_auth_policy_getEntities(options))
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
g.desc 'Remove specified entities from a specified authentication policy.'
|
30
|
+
g.long_desc %( Remove specified entities from a specified authentication policy. )
|
31
|
+
g.command 'removeEntities' do |c|
|
32
|
+
c.flag 'entity_ids', desc: "Encoded IDs of the entities you'd like to remove from the policy."
|
33
|
+
c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
|
34
|
+
c.flag 'policy_name', desc: 'The name of the policy to remove entities from. Currently, email_password is the only policy that may be used with this method.'
|
35
|
+
c.action do |_global_options, options, _args|
|
36
|
+
puts JSON.dump($client.admin_auth_policy_removeEntities(options))
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminBarriers methods.'
|
5
|
+
command 'admin_barriers' do |g|
|
6
|
+
g.desc 'Create an Information Barrier'
|
7
|
+
g.long_desc %( Create an Information Barrier )
|
8
|
+
g.command 'create' do |c|
|
9
|
+
c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
|
10
|
+
c.flag 'primary_usergroup_id', desc: 'The id of the primary IDP Group.'
|
11
|
+
c.flag 'restricted_subjects', desc: 'What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.'
|
12
|
+
c.action do |_global_options, options, _args|
|
13
|
+
puts JSON.dump($client.admin_barriers_create(options))
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
g.desc 'Delete an existing Information Barrier'
|
18
|
+
g.long_desc %( Delete an existing Information Barrier )
|
19
|
+
g.command 'delete' do |c|
|
20
|
+
c.flag 'barrier_id', desc: "The ID of the barrier you're trying to delete."
|
21
|
+
c.action do |_global_options, options, _args|
|
22
|
+
puts JSON.dump($client.admin_barriers_delete(options))
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
g.desc 'Get all Information Barriers for your organization'
|
27
|
+
g.long_desc %( Get all Information Barriers for your organization )
|
28
|
+
g.command 'list' do |c|
|
29
|
+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
|
30
|
+
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
|
31
|
+
c.action do |_global_options, options, _args|
|
32
|
+
puts JSON.dump($client.admin_barriers_list(options))
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
g.desc 'Update an existing Information Barrier'
|
37
|
+
g.long_desc %( Update an existing Information Barrier )
|
38
|
+
g.command 'update' do |c|
|
39
|
+
c.flag 'barrier_id', desc: "The ID of the barrier you're trying to modify."
|
40
|
+
c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
|
41
|
+
c.flag 'primary_usergroup_id', desc: 'The id of the primary IDP Group.'
|
42
|
+
c.flag 'restricted_subjects', desc: 'What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.'
|
43
|
+
c.action do |_global_options, options, _args|
|
44
|
+
puts JSON.dump($client.admin_barriers_update(options))
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
@@ -3,15 +3,167 @@
|
|
3
3
|
|
4
4
|
desc 'AdminConversations methods.'
|
5
5
|
command 'admin_conversations' do |g|
|
6
|
-
g.desc '
|
7
|
-
g.long_desc %(
|
6
|
+
g.desc 'Archive a public or private channel.'
|
7
|
+
g.long_desc %( Archive a public or private channel. )
|
8
|
+
g.command 'archive' do |c|
|
9
|
+
c.flag 'channel_id', desc: 'The channel to archive.'
|
10
|
+
c.action do |_global_options, options, _args|
|
11
|
+
puts JSON.dump($client.admin_conversations_archive(options))
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
g.desc 'Convert a public channel to a private channel.'
|
16
|
+
g.long_desc %( Convert a public channel to a private channel. )
|
17
|
+
g.command 'convertToPrivate' do |c|
|
18
|
+
c.flag 'channel_id', desc: 'The channel to convert to private.'
|
19
|
+
c.action do |_global_options, options, _args|
|
20
|
+
puts JSON.dump($client.admin_conversations_convertToPrivate(options))
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
g.desc 'Create a public or private channel-based conversation.'
|
25
|
+
g.long_desc %( Create a public or private channel-based conversation. )
|
26
|
+
g.command 'create' do |c|
|
27
|
+
c.flag 'is_private', desc: 'When true, creates a private channel instead of a public channel.'
|
28
|
+
c.flag 'name', desc: 'Name of the public or private channel to create.'
|
29
|
+
c.flag 'description', desc: 'Description of the public or private channel to create.'
|
30
|
+
c.flag 'org_wide', desc: 'When true, the channel will be available org-wide. Note: if the channel is not org_wide=true, you must specify a team_id for this channel.'
|
31
|
+
c.flag 'team_id', desc: 'The workspace to create the channel in. Note: this argument is required unless you set org_wide=true.'
|
32
|
+
c.action do |_global_options, options, _args|
|
33
|
+
puts JSON.dump($client.admin_conversations_create(options))
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
g.desc 'Delete a public or private channel.'
|
38
|
+
g.long_desc %( Delete a public or private channel. )
|
39
|
+
g.command 'delete' do |c|
|
40
|
+
c.flag 'channel_id', desc: 'The channel to delete.'
|
41
|
+
c.action do |_global_options, options, _args|
|
42
|
+
puts JSON.dump($client.admin_conversations_delete(options))
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
g.desc 'Disconnect a connected channel from one or more workspaces.'
|
47
|
+
g.long_desc %( Disconnect a connected channel from one or more workspaces. )
|
48
|
+
g.command 'disconnectShared' do |c|
|
49
|
+
c.flag 'channel_id', desc: 'The channel to be disconnected from some workspaces.'
|
50
|
+
c.flag 'leaving_team_ids', desc: 'team IDs getting removed from the channel, optional if there are only two teams in the channel.'
|
51
|
+
c.action do |_global_options, options, _args|
|
52
|
+
puts JSON.dump($client.admin_conversations_disconnectShared(options))
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
g.desc 'Get conversation preferences for a public or private channel.'
|
57
|
+
g.long_desc %( Get conversation preferences for a public or private channel. )
|
58
|
+
g.command 'getConversationPrefs' do |c|
|
59
|
+
c.flag 'channel_id', desc: 'The channel to get preferences for.'
|
60
|
+
c.action do |_global_options, options, _args|
|
61
|
+
puts JSON.dump($client.admin_conversations_getConversationPrefs(options))
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
g.desc "This API endpoint can be used by any admin to get a channel's retention policy."
|
66
|
+
g.long_desc %( This API endpoint can be used by any admin to get a channel's retention policy. )
|
67
|
+
g.command 'getCustomRetention' do |c|
|
68
|
+
c.flag 'channel_id', desc: 'The channel to get the retention policy for.'
|
69
|
+
c.action do |_global_options, options, _args|
|
70
|
+
puts JSON.dump($client.admin_conversations_getCustomRetention(options))
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
g.desc 'Get all the workspaces a given public or private channel is connected to within this Enterprise org.'
|
75
|
+
g.long_desc %( Get all the workspaces a given public or private channel is connected to within this Enterprise org. )
|
76
|
+
g.command 'getTeams' do |c|
|
77
|
+
c.flag 'channel_id', desc: 'The channel to determine connected workspaces within the organization for.'
|
78
|
+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
|
79
|
+
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
|
80
|
+
c.action do |_global_options, options, _args|
|
81
|
+
puts JSON.dump($client.admin_conversations_getTeams(options))
|
82
|
+
end
|
83
|
+
end
|
84
|
+
|
85
|
+
g.desc 'Invite a user to a public or private channel.'
|
86
|
+
g.long_desc %( Invite a user to a public or private channel. )
|
87
|
+
g.command 'invite' do |c|
|
88
|
+
c.flag 'channel_id', desc: 'The channel that the users will be invited to.'
|
89
|
+
c.flag 'user_ids', desc: 'The users to invite.'
|
90
|
+
c.action do |_global_options, options, _args|
|
91
|
+
puts JSON.dump($client.admin_conversations_invite(options))
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
95
|
+
g.desc "This API endpoint can be used by any admin to remove a channel's retention policy."
|
96
|
+
g.long_desc %( This API endpoint can be used by any admin to remove a channel's retention policy. )
|
97
|
+
g.command 'removeCustomRetention' do |c|
|
98
|
+
c.flag 'channel_id', desc: 'The channel to set the retention policy for.'
|
99
|
+
c.action do |_global_options, options, _args|
|
100
|
+
puts JSON.dump($client.admin_conversations_removeCustomRetention(options))
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
g.desc 'Rename a public or private channel.'
|
105
|
+
g.long_desc %( Rename a public or private channel. )
|
106
|
+
g.command 'rename' do |c|
|
107
|
+
c.flag 'channel_id', desc: 'The channel to rename.'
|
108
|
+
c.flag 'name', desc: '.'
|
109
|
+
c.action do |_global_options, options, _args|
|
110
|
+
puts JSON.dump($client.admin_conversations_rename(options))
|
111
|
+
end
|
112
|
+
end
|
113
|
+
|
114
|
+
g.desc 'Search for public or private channels in an Enterprise organization.'
|
115
|
+
g.long_desc %( Search for public or private channels in an Enterprise organization. )
|
116
|
+
g.command 'search' do |c|
|
117
|
+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
|
118
|
+
c.flag 'limit', desc: 'Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.'
|
119
|
+
c.flag 'query', desc: 'Name of the the channel to query by.'
|
120
|
+
c.flag 'search_channel_types', desc: 'The type of channel to include or exclude in the search. For example private will search private channels, while private_exclude will exclude them. For a full list of types, check the Types section.'
|
121
|
+
c.flag 'sort', desc: 'Possible values are relevant (search ranking based on what we think is closest), name (alphabetical), member_count (number of users in the channel), and created (date channel was created). You can optionally pair this with the sort_dir arg to change how it is sorted.'
|
122
|
+
c.flag 'sort_dir', desc: 'Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a).'
|
123
|
+
c.flag 'team_ids', desc: 'Comma separated string of team IDs, signifying the workspaces to search through.'
|
124
|
+
c.action do |_global_options, options, _args|
|
125
|
+
puts JSON.dump($client.admin_conversations_search(options))
|
126
|
+
end
|
127
|
+
end
|
128
|
+
|
129
|
+
g.desc 'Set the posting permissions for a public or private channel.'
|
130
|
+
g.long_desc %( Set the posting permissions for a public or private channel. )
|
131
|
+
g.command 'setConversationPrefs' do |c|
|
132
|
+
c.flag 'channel_id', desc: 'The channel to set the prefs for.'
|
133
|
+
c.flag 'prefs', desc: 'The prefs for this channel in a stringified JSON format.'
|
134
|
+
c.action do |_global_options, options, _args|
|
135
|
+
puts JSON.dump($client.admin_conversations_setConversationPrefs(options))
|
136
|
+
end
|
137
|
+
end
|
138
|
+
|
139
|
+
g.desc "This API endpoint can be used by any admin to set a channel's retention policy."
|
140
|
+
g.long_desc %( This API endpoint can be used by any admin to set a channel's retention policy. )
|
141
|
+
g.command 'setCustomRetention' do |c|
|
142
|
+
c.flag 'channel_id', desc: 'The channel to set the retention policy for.'
|
143
|
+
c.flag 'duration_days', desc: 'The message retention duration in days to set for this channel.'
|
144
|
+
c.action do |_global_options, options, _args|
|
145
|
+
puts JSON.dump($client.admin_conversations_setCustomRetention(options))
|
146
|
+
end
|
147
|
+
end
|
148
|
+
|
149
|
+
g.desc 'Set the workspaces in an Enterprise grid org that connect to a public or private channel.'
|
150
|
+
g.long_desc %( Set the workspaces in an Enterprise grid org that connect to a public or private channel. )
|
8
151
|
g.command 'setTeams' do |c|
|
9
152
|
c.flag 'channel_id', desc: 'The encoded channel_id to add or remove to workspaces.'
|
10
153
|
c.flag 'org_channel', desc: 'True if channel has to be converted to an org channel.'
|
11
|
-
c.flag 'target_team_ids', desc:
|
154
|
+
c.flag 'target_team_ids', desc: 'A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.'
|
12
155
|
c.flag 'team_id', desc: 'The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.'
|
13
156
|
c.action do |_global_options, options, _args|
|
14
157
|
puts JSON.dump($client.admin_conversations_setTeams(options))
|
15
158
|
end
|
16
159
|
end
|
160
|
+
|
161
|
+
g.desc 'Unarchive a public or private channel.'
|
162
|
+
g.long_desc %( Unarchive a public or private channel. )
|
163
|
+
g.command 'unarchive' do |c|
|
164
|
+
c.flag 'channel_id', desc: 'The channel to unarchive.'
|
165
|
+
c.action do |_global_options, options, _args|
|
166
|
+
puts JSON.dump($client.admin_conversations_unarchive(options))
|
167
|
+
end
|
168
|
+
end
|
17
169
|
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminConversationsEkm methods.'
|
5
|
+
command 'admin_conversations_ekm' do |g|
|
6
|
+
g.desc 'List all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM.'
|
7
|
+
g.long_desc %( List all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM. )
|
8
|
+
g.command 'listOriginalConnectedChannelInfo' do |c|
|
9
|
+
c.flag 'channel_ids', desc: 'A comma-separated list of channels to filter to.'
|
10
|
+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
|
11
|
+
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
|
12
|
+
c.flag 'team_ids', desc: 'A comma-separated list of the workspaces to which the channels you would like returned belong.'
|
13
|
+
c.action do |_global_options, options, _args|
|
14
|
+
puts JSON.dump($client.admin_conversations_ekm_listOriginalConnectedChannelInfo(options))
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminConversationsRestrictaccess methods.'
|
5
|
+
command 'admin_conversations_restrictAccess' do |g|
|
6
|
+
g.desc 'Add an allowlist of IDP groups for accessing a channel'
|
7
|
+
g.long_desc %( Add an allowlist of IDP groups for accessing a channel )
|
8
|
+
g.command 'addGroup' do |c|
|
9
|
+
c.flag 'channel_id', desc: 'The channel to link this group to.'
|
10
|
+
c.flag 'group_id', desc: 'The IDP Group ID to be an allowlist for the private channel.'
|
11
|
+
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.'
|
12
|
+
c.action do |_global_options, options, _args|
|
13
|
+
puts JSON.dump($client.admin_conversations_restrictAccess_addGroup(options))
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
g.desc 'List all IDP Groups linked to a channel'
|
18
|
+
g.long_desc %( List all IDP Groups linked to a channel )
|
19
|
+
g.command 'listGroups' do |c|
|
20
|
+
c.flag 'channel_id', desc: '.'
|
21
|
+
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.'
|
22
|
+
c.action do |_global_options, options, _args|
|
23
|
+
puts JSON.dump($client.admin_conversations_restrictAccess_listGroups(options))
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
g.desc 'Remove a linked IDP group linked from a private channel'
|
28
|
+
g.long_desc %( Remove a linked IDP group linked from a private channel )
|
29
|
+
g.command 'removeGroup' do |c|
|
30
|
+
c.flag 'channel_id', desc: 'The channel to remove the linked group from.'
|
31
|
+
c.flag 'group_id', desc: 'The IDP Group ID to remove from the private channel.'
|
32
|
+
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.'
|
33
|
+
c.action do |_global_options, options, _args|
|
34
|
+
puts JSON.dump($client.admin_conversations_restrictAccess_removeGroup(options))
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'Add and remove user groups from conversations. Use admin.conversations.* equivalents instead.'
|
5
|
+
command 'admin_conversations_whitelist' do |g|
|
6
|
+
g.desc 'Add an allowlist of IDP groups for accessing a channel'
|
7
|
+
g.long_desc %( Add an allowlist of IDP groups for accessing a channel )
|
8
|
+
g.command 'add' do |c|
|
9
|
+
c.flag 'channel_id', desc: 'The channel to whitelist a group for.'
|
10
|
+
c.flag 'group_id', desc: 'The IDP Group ID to whitelist for the private channel.'
|
11
|
+
c.flag 'team_id', desc: 'The workspace where the IDP Group and channel exist.'
|
12
|
+
c.action do |_global_options, options, _args|
|
13
|
+
puts JSON.dump($client.admin_conversations_whitelist_add(options))
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
g.desc 'List all IDP Groups linked to a channel'
|
18
|
+
g.long_desc %( List all IDP Groups linked to a channel )
|
19
|
+
g.command 'listGroupsLinkedToChannel' do |c|
|
20
|
+
c.flag 'channel_id', desc: '.'
|
21
|
+
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.'
|
22
|
+
c.action do |_global_options, options, _args|
|
23
|
+
puts JSON.dump($client.admin_conversations_whitelist_listGroupsLinkedToChannel(options))
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
g.desc 'Remove an allowlisted IDP group linked to a private channel'
|
28
|
+
g.long_desc %( Remove an allowlisted IDP group linked to a private channel )
|
29
|
+
g.command 'remove' do |c|
|
30
|
+
c.flag 'channel_id', desc: 'The channel to remove a whitelisted group for.'
|
31
|
+
c.flag 'group_id', desc: 'The IDP Group ID to remove from the private channel whitelist.'
|
32
|
+
c.flag 'team_id', desc: 'The workspace where the IDP Group and channel exist.'
|
33
|
+
c.action do |_global_options, options, _args|
|
34
|
+
puts JSON.dump($client.admin_conversations_whitelist_remove(options))
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
data/bin/commands/admin_emoji.rb
CHANGED
@@ -6,7 +6,7 @@ command 'admin_emoji' do |g|
|
|
6
6
|
g.desc 'Add an emoji.'
|
7
7
|
g.long_desc %( Add an emoji. )
|
8
8
|
g.command 'add' do |c|
|
9
|
-
c.flag 'name', desc: 'The name of the emoji to be
|
9
|
+
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.'
|
10
10
|
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.'
|
11
11
|
c.action do |_global_options, options, _args|
|
12
12
|
puts JSON.dump($client.admin_emoji_add(options))
|
data/bin/commands/admin_teams.rb
CHANGED
@@ -6,7 +6,7 @@ command 'admin_teams' do |g|
|
|
6
6
|
g.desc 'Create an Enterprise team.'
|
7
7
|
g.long_desc %( Create an Enterprise team. )
|
8
8
|
g.command 'create' do |c|
|
9
|
-
c.flag 'team_domain', desc: 'Team domain (for example, slacksoftballteam).'
|
9
|
+
c.flag 'team_domain', desc: 'Team domain (for example, slacksoftballteam). Domains are limited to 21 characters.'
|
10
10
|
c.flag 'team_name', desc: 'Team name (for example, Slack Softball Team).'
|
11
11
|
c.flag 'team_description', desc: 'Description for the team.'
|
12
12
|
c.flag 'team_discoverability', desc: "Who can join the team. A team's discoverability can be open, closed, invite_only, or unlisted."
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminUsergroups methods.'
|
5
|
+
command 'admin_usergroups' do |g|
|
6
|
+
g.desc 'Add up to one hundred default channels to an IDP group.'
|
7
|
+
g.long_desc %( Add up to one hundred default channels to an IDP group. )
|
8
|
+
g.command 'addChannels' do |c|
|
9
|
+
c.flag 'channel_ids', desc: 'Comma separated string of channel IDs.'
|
10
|
+
c.flag 'usergroup_id', desc: 'ID of the IDP group to add default channels for.'
|
11
|
+
c.flag 'team_id', desc: 'The workspace to add default channels in.'
|
12
|
+
c.action do |_global_options, options, _args|
|
13
|
+
puts JSON.dump($client.admin_usergroups_addChannels(options))
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
g.desc 'Associate one or more default workspaces with an organization-wide IDP group.'
|
18
|
+
g.long_desc %( Associate one or more default workspaces with an organization-wide IDP group. )
|
19
|
+
g.command 'addTeams' do |c|
|
20
|
+
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.'
|
21
|
+
c.flag 'usergroup_id', desc: 'An encoded usergroup (IDP Group) ID.'
|
22
|
+
c.flag 'auto_provision', desc: 'When true, this method automatically creates new workspace accounts for the IDP group members.'
|
23
|
+
c.action do |_global_options, options, _args|
|
24
|
+
puts JSON.dump($client.admin_usergroups_addTeams(options))
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
g.desc 'List the channels linked to an org-level IDP group (user group).'
|
29
|
+
g.long_desc %( List the channels linked to an org-level IDP group (user group). )
|
30
|
+
g.command 'listChannels' do |c|
|
31
|
+
c.flag 'usergroup_id', desc: 'ID of the IDP group to list default channels for.'
|
32
|
+
c.flag 'include_num_members', desc: 'Flag to include or exclude the count of members per channel.'
|
33
|
+
c.flag 'team_id', desc: 'ID of the the workspace.'
|
34
|
+
c.action do |_global_options, options, _args|
|
35
|
+
puts JSON.dump($client.admin_usergroups_listChannels(options))
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
g.desc 'Remove one or more default channels from an org-level IDP group (user group).'
|
40
|
+
g.long_desc %( Remove one or more default channels from an org-level IDP group (user group). )
|
41
|
+
g.command 'removeChannels' do |c|
|
42
|
+
c.flag 'channel_ids', desc: 'Comma-separated string of channel IDs.'
|
43
|
+
c.flag 'usergroup_id', desc: 'ID of the IDP Group.'
|
44
|
+
c.action do |_global_options, options, _args|
|
45
|
+
puts JSON.dump($client.admin_usergroups_removeChannels(options))
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
data/bin/commands/admin_users.rb
CHANGED
@@ -23,6 +23,7 @@ command 'admin_users' do |g|
|
|
23
23
|
c.flag 'email', desc: 'The email address of the person to invite.'
|
24
24
|
c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
|
25
25
|
c.flag 'custom_message', desc: 'An optional message to send to the user in the invite email.'
|
26
|
+
c.flag 'email_password_policy_enabled', desc: 'Allow invited user to sign in via email and password. Only available for Enterprise Grid teams via admin invite.'
|
26
27
|
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.'
|
27
28
|
c.flag 'is_restricted', desc: 'Is this user a multi-channel guest user? (default: false).'
|
28
29
|
c.flag 'is_ultra_restricted', desc: 'Is this user a single channel guest user? (default: false).'
|
@@ -36,9 +37,9 @@ command 'admin_users' do |g|
|
|
36
37
|
g.desc 'List users on a workspace'
|
37
38
|
g.long_desc %( List users on a workspace )
|
38
39
|
g.command 'list' do |c|
|
39
|
-
c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
|
40
40
|
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
|
41
41
|
c.flag 'limit', desc: 'Limit for how many users to be retrieved per page.'
|
42
|
+
c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
|
42
43
|
c.action do |_global_options, options, _args|
|
43
44
|
puts JSON.dump($client.admin_users_list(options))
|
44
45
|
end
|
@@ -68,8 +69,8 @@ command 'admin_users' do |g|
|
|
68
69
|
g.long_desc %( Set an expiration for a guest user )
|
69
70
|
g.command 'setExpiration' do |c|
|
70
71
|
c.flag 'expiration_ts', desc: 'Timestamp when guest account should be disabled.'
|
71
|
-
c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
|
72
72
|
c.flag 'user_id', desc: 'The ID of the user to set an expiration for.'
|
73
|
+
c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
|
73
74
|
c.action do |_global_options, options, _args|
|
74
75
|
puts JSON.dump($client.admin_users_setExpiration(options))
|
75
76
|
end
|