slack-ruby-client 0.7.9 → 0.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.github/FUNDING.yml +1 -0
- data/.gitignore +2 -0
- data/.rubocop.yml +32 -1
- data/.rubocop_todo.yml +98 -49
- data/.travis.yml +10 -14
- data/CHANGELOG.md +172 -24
- data/CONTRIBUTING.md +17 -6
- data/Dangerfile +2 -0
- data/Gemfile +10 -4
- data/LICENSE.md +1 -1
- data/README.md +276 -54
- data/RELEASING.md +19 -11
- data/Rakefile +2 -1
- data/UPGRADING.md +84 -2
- data/bin/commands.rb +43 -1
- data/bin/commands/admin_analytics.rb +15 -0
- data/bin/commands/admin_apps.rb +40 -0
- data/bin/commands/admin_apps_approved.rb +17 -0
- data/bin/commands/admin_apps_requests.rb +16 -0
- data/bin/commands/admin_apps_restricted.rb +17 -0
- data/bin/commands/admin_barriers.rb +47 -0
- data/bin/commands/admin_conversations.rb +169 -0
- 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 +54 -0
- data/bin/commands/admin_inviteRequests.rb +36 -0
- data/bin/commands/admin_inviteRequests_approved.rb +16 -0
- data/bin/commands/admin_inviteRequests_denied.rb +16 -0
- data/bin/commands/admin_teams.rb +27 -0
- data/bin/commands/admin_teams_admins.rb +16 -0
- data/bin/commands/admin_teams_owners.rb +16 -0
- data/bin/commands/admin_teams_settings.rb +64 -0
- data/bin/commands/admin_usergroups.rb +48 -0
- data/bin/commands/admin_users.rb +97 -0
- data/bin/commands/admin_users_session.rb +38 -0
- data/bin/commands/api.rb +3 -3
- data/bin/commands/apps.rb +15 -0
- data/bin/commands/apps_connections.rb +13 -0
- data/bin/commands/apps_event_authorizations.rb +16 -0
- data/bin/commands/apps_permissions.rb +23 -0
- data/bin/commands/apps_permissions_resources.rb +15 -0
- data/bin/commands/apps_permissions_scopes.rb +13 -0
- data/bin/commands/apps_permissions_users.rb +26 -0
- data/bin/commands/auth.rb +5 -4
- data/bin/commands/auth_teams.rb +16 -0
- data/bin/commands/bots.rb +4 -2
- data/bin/commands/calls.rb +52 -0
- data/bin/commands/calls_participants.rb +25 -0
- data/bin/commands/channels.rb +64 -43
- data/bin/commands/chat.rb +114 -24
- data/bin/commands/chat_scheduledMessages.rb +19 -0
- data/bin/commands/conversations.rb +196 -0
- data/bin/commands/dialog.rb +15 -0
- data/bin/commands/dnd.rb +9 -8
- data/bin/commands/emoji.rb +3 -2
- data/bin/commands/files.rb +45 -30
- data/bin/commands/files_comments.rb +3 -24
- data/bin/commands/files_remote.rb +78 -0
- data/bin/commands/groups.rb +53 -53
- data/bin/commands/im.rb +17 -13
- data/bin/commands/migration.rb +16 -0
- data/bin/commands/mpim.rb +16 -13
- data/bin/commands/oauth.rb +17 -2
- data/bin/commands/oauth_v2.rb +17 -0
- data/bin/commands/pins.rb +7 -10
- data/bin/commands/reactions.rb +17 -15
- data/bin/commands/reminders.rb +11 -10
- data/bin/commands/rtm.rb +19 -4
- data/bin/commands/search.rb +15 -11
- data/bin/commands/stars.rb +11 -8
- data/bin/commands/team.rb +15 -10
- data/bin/commands/team_profile.rb +3 -2
- data/bin/commands/usergroups.rb +22 -16
- data/bin/commands/usergroups_users.rb +7 -4
- data/bin/commands/users.rb +65 -37
- data/bin/commands/users_admin.rb +29 -0
- data/bin/commands/users_prefs.rb +13 -0
- data/bin/commands/users_profile.rb +8 -7
- data/bin/commands/views.rb +48 -0
- data/bin/commands/workflows.rb +38 -0
- data/bin/slack +3 -4
- data/examples/hi_real_time_and_web/Gemfile +1 -0
- data/examples/hi_real_time_and_web/hi.rb +8 -4
- data/examples/{hi_real_time_async_eventmachine → hi_real_time_async_async}/Gemfile +2 -1
- data/examples/{hi_real_time_async_celluloid → hi_real_time_async_async}/Procfile +0 -0
- data/examples/{hi_real_time_async_celluloid → hi_real_time_async_async}/hi.rb +13 -8
- data/examples/hi_web/Gemfile +1 -0
- data/examples/hi_web/hi.rb +2 -1
- data/examples/new_ticket/Gemfile +1 -0
- data/examples/new_ticket/new_ticket.rb +2 -1
- data/lib/slack-ruby-client.rb +40 -26
- data/lib/slack.rb +1 -0
- data/lib/slack/config.rb +1 -0
- data/lib/slack/events/config.rb +32 -0
- data/lib/slack/events/request.rb +70 -0
- data/lib/slack/logger.rb +6 -5
- data/lib/slack/messages/formatting.rb +4 -4
- data/lib/slack/messages/message.rb +2 -6
- data/lib/slack/real_time/api/message.rb +3 -1
- data/lib/slack/real_time/api/message_id.rb +1 -0
- data/lib/slack/real_time/api/ping.rb +5 -2
- data/lib/slack/real_time/api/templates/event_handler.erb +1 -1
- data/lib/slack/real_time/api/typing.rb +3 -1
- data/lib/slack/real_time/client.rb +113 -32
- data/lib/slack/real_time/concurrency.rb +2 -2
- data/lib/slack/real_time/concurrency/async.rb +140 -0
- data/lib/slack/real_time/config.rb +20 -12
- data/lib/slack/real_time/models.rb +8 -7
- data/lib/slack/real_time/models/base.rb +2 -6
- data/lib/slack/real_time/models/bot.rb +1 -0
- data/lib/slack/real_time/models/channel.rb +1 -0
- data/lib/slack/real_time/models/group.rb +1 -0
- data/lib/slack/real_time/models/im.rb +1 -0
- data/lib/slack/real_time/models/team.rb +1 -0
- data/lib/slack/real_time/models/user.rb +1 -0
- data/lib/slack/real_time/socket.rb +46 -17
- data/lib/slack/real_time/stores.rb +4 -3
- data/lib/slack/real_time/stores/base.rb +5 -3
- data/lib/slack/real_time/stores/starter.rb +113 -72
- data/lib/slack/real_time/stores/store.rb +131 -88
- data/lib/slack/version.rb +2 -1
- data/lib/slack/web/api/endpoints.rb +110 -26
- data/lib/slack/web/api/endpoints/admin_analytics.rb +26 -0
- data/lib/slack/web/api/endpoints/admin_apps.rb +62 -0
- data/lib/slack/web/api/endpoints/admin_apps_approved.rb +35 -0
- data/lib/slack/web/api/endpoints/admin_apps_requests.rb +33 -0
- data/lib/slack/web/api/endpoints/admin_apps_restricted.rb +35 -0
- data/lib/slack/web/api/endpoints/admin_barriers.rb +82 -0
- data/lib/slack/web/api/endpoints/admin_conversations.rb +260 -0
- 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 +88 -0
- data/lib/slack/web/api/endpoints/admin_inviteRequests.rb +61 -0
- data/lib/slack/web/api/endpoints/admin_inviteRequests_approved.rb +33 -0
- data/lib/slack/web/api/endpoints/admin_inviteRequests_denied.rb +33 -0
- data/lib/slack/web/api/endpoints/admin_teams.rb +50 -0
- data/lib/slack/web/api/endpoints/admin_teams_admins.rb +34 -0
- data/lib/slack/web/api/endpoints/admin_teams_owners.rb +34 -0
- data/lib/slack/web/api/endpoints/admin_teams_settings.rb +99 -0
- data/lib/slack/web/api/endpoints/admin_usergroups.rb +77 -0
- data/lib/slack/web/api/endpoints/admin_users.rb +161 -0
- data/lib/slack/web/api/endpoints/admin_users_session.rb +66 -0
- data/lib/slack/web/api/endpoints/api.rb +3 -4
- data/lib/slack/web/api/endpoints/apps.rb +27 -0
- 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_permissions.rb +36 -0
- data/lib/slack/web/api/endpoints/apps_permissions_resources.rb +31 -0
- data/lib/slack/web/api/endpoints/apps_permissions_scopes.rb +21 -0
- data/lib/slack/web/api/endpoints/apps_permissions_users.rb +50 -0
- data/lib/slack/web/api/endpoints/auth.rb +5 -4
- data/lib/slack/web/api/endpoints/auth_teams.rb +33 -0
- data/lib/slack/web/api/endpoints/bots.rb +5 -2
- 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 +105 -49
- data/lib/slack/web/api/endpoints/chat.rb +221 -40
- data/lib/slack/web/api/endpoints/chat_scheduledMessages.rb +40 -0
- data/lib/slack/web/api/endpoints/conversations.rb +332 -0
- data/lib/slack/web/api/endpoints/dialog.rb +33 -0
- data/lib/slack/web/api/endpoints/dnd.rb +11 -9
- data/lib/slack/web/api/endpoints/emoji.rb +3 -2
- data/lib/slack/web/api/endpoints/files.rb +75 -38
- data/lib/slack/web/api/endpoints/files_comments.rb +3 -38
- data/lib/slack/web/api/endpoints/files_remote.rb +127 -0
- data/lib/slack/web/api/endpoints/groups.rb +76 -53
- data/lib/slack/web/api/endpoints/im.rb +38 -21
- data/lib/slack/web/api/endpoints/migration.rb +28 -0
- data/lib/slack/web/api/endpoints/mpim.rb +37 -22
- data/lib/slack/web/api/endpoints/oauth.rb +25 -4
- data/lib/slack/web/api/endpoints/oauth_v2.rb +30 -0
- data/lib/slack/web/api/endpoints/pins.rb +10 -19
- data/lib/slack/web/api/endpoints/presence.rb +1 -1
- data/lib/slack/web/api/endpoints/reactions.rb +37 -28
- data/lib/slack/web/api/endpoints/reminders.rb +11 -10
- data/lib/slack/web/api/endpoints/rtm.rb +28 -7
- data/lib/slack/web/api/endpoints/search.rb +21 -14
- data/lib/slack/web/api/endpoints/stars.rb +24 -15
- data/lib/slack/web/api/endpoints/team.rb +21 -13
- data/lib/slack/web/api/endpoints/team_profile.rb +3 -2
- data/lib/slack/web/api/endpoints/usergroups.rb +33 -22
- data/lib/slack/web/api/endpoints/usergroups_users.rb +9 -4
- data/lib/slack/web/api/endpoints/users.rb +78 -29
- data/lib/slack/web/api/endpoints/users_admin.rb +49 -0
- data/lib/slack/web/api/endpoints/users_prefs.rb +21 -0
- data/lib/slack/web/api/endpoints/users_profile.rb +11 -10
- data/lib/slack/web/api/endpoints/views.rb +97 -0
- data/lib/slack/web/api/endpoints/workflows.rb +61 -0
- data/lib/slack/web/api/error.rb +2 -8
- data/lib/slack/web/api/errors.rb +850 -0
- data/lib/slack/web/api/errors/internal_error.rb +14 -0
- data/lib/slack/web/api/errors/slack_error.rb +29 -0
- data/lib/slack/web/api/errors/too_many_requests_error.rb +24 -0
- data/lib/slack/web/api/mixins.rb +6 -4
- data/lib/slack/web/api/mixins/channels.id.rb +6 -7
- data/lib/slack/web/api/mixins/conversations.id.rb +25 -0
- data/lib/slack/web/api/mixins/groups.id.rb +6 -7
- data/lib/slack/web/api/mixins/ids.id.rb +24 -0
- data/lib/slack/web/api/mixins/users.id.rb +6 -7
- data/lib/slack/web/api/mixins/users.search.rb +39 -36
- data/lib/slack/web/api/patches/chat.1.patch +72 -0
- data/lib/slack/web/api/patches/dialog.1.open-json-support.patch +17 -0
- data/lib/slack/web/api/patches/views.1.view-json.patch +40 -0
- data/lib/slack/web/api/patches/views.1.views-published.patch +16 -0
- data/lib/slack/web/api/templates/command.erb +5 -3
- data/lib/slack/web/api/templates/commands.erb +2 -1
- data/lib/slack/web/api/templates/endpoints.erb +5 -3
- data/lib/slack/web/api/templates/errors.erb +20 -0
- data/lib/slack/web/api/templates/method.erb +26 -4
- data/lib/slack/web/api/templates/method_spec.erb +3 -2
- data/lib/slack/web/client.rb +2 -1
- data/lib/slack/web/config.rb +21 -10
- data/lib/slack/web/faraday/connection.rb +25 -16
- data/lib/slack/web/faraday/request.rb +2 -0
- data/lib/slack/web/faraday/response/raise_error.rb +23 -1
- data/lib/slack/web/faraday/response/wrap_error.rb +18 -0
- data/lib/slack/web/pagination/cursor.rb +52 -0
- data/lib/slack_ruby_client.rb +1 -0
- data/lib/tasks/git.rake +2 -1
- data/lib/tasks/real_time.rake +16 -6
- data/lib/tasks/update.rake +1 -0
- data/lib/tasks/web.rake +38 -10
- data/screenshots/create-app.png +0 -0
- data/slack-ruby-client.gemspec +9 -6
- data/spec/fixtures/slack/web/429_error.yml +2 -0
- data/spec/fixtures/slack/web/503_error.yml +14 -0
- data/spec/fixtures/slack/web/channels_info.yml +108 -15
- data/spec/fixtures/slack/web/conversations_setTopic.yml +69 -0
- data/spec/fixtures/slack/web/conversations_setTopic_one_page.yml +142 -0
- data/spec/fixtures/slack/web/conversations_setTopic_paginated.yml +208 -0
- data/spec/fixtures/slack/web/paginated_users_list.yml +181 -0
- data/spec/fixtures/slack/web/rtm_connect.yml +70 -0
- data/spec/fixtures/slack/web/rtm_start.yml +1 -1
- data/spec/fixtures/slack/web/views_open_error.yml +76 -0
- data/spec/integration/integration_spec.rb +116 -48
- data/spec/slack/config_spec.rb +2 -0
- data/spec/slack/events/config_spec.rb +33 -0
- data/spec/slack/events/request_spec.rb +183 -0
- data/spec/slack/messages/formatting_spec.rb +25 -14
- data/spec/slack/real_time/api/message_spec.rb +6 -1
- data/spec/slack/real_time/api/ping_spec.rb +2 -0
- data/spec/slack/real_time/api/typing_spec.rb +5 -1
- data/spec/slack/real_time/client_spec.rb +462 -134
- data/spec/slack/real_time/concurrency/it_behaves_like_a_realtime_socket.rb +3 -1
- data/spec/slack/real_time/event_handlers/bot_spec.rb +6 -3
- data/spec/slack/real_time/event_handlers/channel_spec.rb +9 -6
- data/spec/slack/real_time/event_handlers/event_handlers_spec.rb +3 -2
- data/spec/slack/real_time/event_handlers/group_spec.rb +5 -4
- data/spec/slack/real_time/event_handlers/im_spec.rb +4 -3
- data/spec/slack/real_time/event_handlers/team_spec.rb +8 -4
- data/spec/slack/real_time/event_handlers/user_spec.rb +5 -2
- data/spec/slack/real_time/rtm_connect_spec.rb +14 -0
- data/spec/slack/real_time/rtm_start_spec.rb +1 -0
- data/spec/slack/real_time/store_spec.rb +2 -1
- data/spec/slack/slack_spec.rb +39 -7
- data/spec/slack/version_spec.rb +2 -1
- data/spec/slack/web/api/endpoints/admin_analytics_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/admin_apps_approved_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/admin_apps_requests_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/admin_apps_restricted_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/admin_apps_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/admin_barriers_spec.rb +38 -0
- data/spec/slack/web/api/endpoints/admin_conversations_ekm_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/admin_conversations_restrictAccess_spec.rb +32 -0
- data/spec/slack/web/api/endpoints/admin_conversations_spec.rb +98 -0
- data/spec/slack/web/api/endpoints/admin_conversations_whitelist_spec.rb +32 -0
- data/spec/slack/web/api/endpoints/admin_emoji_spec.rb +37 -0
- data/spec/slack/web/api/endpoints/admin_inviteRequests_approved_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/admin_inviteRequests_denied_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/admin_inviteRequests_spec.rb +18 -0
- data/spec/slack/web/api/endpoints/admin_teams_admins_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/admin_teams_owners_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/admin_teams_settings_spec.rb +53 -0
- data/spec/slack/web/api/endpoints/admin_teams_spec.rb +16 -0
- data/spec/slack/web/api/endpoints/admin_usergroups_spec.rb +37 -0
- data/spec/slack/web/api/endpoints/admin_users_session_spec.rb +21 -0
- data/spec/slack/web/api/endpoints/admin_users_spec.rb +67 -0
- data/spec/slack/web/api/endpoints/api_spec.rb +1 -0
- data/spec/slack/web/api/endpoints/apps_connections_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/apps_event_authorizations_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/apps_permissions_resources_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/apps_permissions_scopes_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/apps_permissions_spec.rb +16 -0
- data/spec/slack/web/api/endpoints/apps_permissions_users_spec.rb +19 -0
- data/spec/slack/web/api/endpoints/apps_spec.rb +16 -0
- data/spec/slack/web/api/endpoints/auth_teams_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/bots_spec.rb +1 -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/chat_scheduledMessages_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/conversations_spec.rb +109 -0
- data/spec/slack/web/api/endpoints/custom_specs/auth_spec.rb +13 -4
- data/spec/slack/web/api/endpoints/custom_specs/channels_spec.rb +5 -3
- data/spec/slack/web/api/endpoints/custom_specs/chat_spec.rb +140 -24
- data/spec/slack/web/api/endpoints/custom_specs/dialog_spec.rb +36 -0
- data/spec/slack/web/api/endpoints/custom_specs/groups_spec.rb +2 -0
- data/spec/slack/web/api/endpoints/custom_specs/users_spec.rb +21 -6
- data/spec/slack/web/api/endpoints/custom_specs/views_spec.rb +95 -0
- data/spec/slack/web/api/endpoints/dnd_spec.rb +6 -0
- data/spec/slack/web/api/endpoints/emoji_spec.rb +1 -0
- data/spec/slack/web/api/endpoints/files_comments_spec.rb +3 -21
- data/spec/slack/web/api/endpoints/files_remote_spec.rb +24 -0
- data/spec/slack/web/api/endpoints/files_spec.rb +17 -5
- data/spec/slack/web/api/endpoints/im_spec.rb +5 -4
- data/spec/slack/web/api/endpoints/migration_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/mpim_spec.rb +5 -4
- data/spec/slack/web/api/endpoints/oauth_spec.rb +5 -4
- data/spec/slack/web/api/endpoints/oauth_v2_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/pins_spec.rb +1 -0
- data/spec/slack/web/api/endpoints/reactions_spec.rb +8 -1
- data/spec/slack/web/api/endpoints/reminders_spec.rb +3 -2
- data/spec/slack/web/api/endpoints/rtm_spec.rb +1 -0
- data/spec/slack/web/api/endpoints/search_spec.rb +1 -0
- data/spec/slack/web/api/endpoints/stars_spec.rb +1 -0
- data/spec/slack/web/api/endpoints/team_profile_spec.rb +1 -0
- data/spec/slack/web/api/endpoints/team_spec.rb +1 -0
- data/spec/slack/web/api/endpoints/usergroups_spec.rb +1 -0
- data/spec/slack/web/api/endpoints/usergroups_users_spec.rb +3 -2
- data/spec/slack/web/api/endpoints/users_admin_spec.rb +18 -0
- data/spec/slack/web/api/endpoints/users_prefs_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/users_profile_spec.rb +1 -0
- data/spec/slack/web/api/endpoints/views_spec.rb +29 -0
- data/spec/slack/web/api/endpoints/workflows_spec.rb +26 -0
- data/spec/slack/web/api/error_spec.rb +5 -3
- data/spec/slack/web/api/errors/slack_error_spec.rb +38 -0
- data/spec/slack/web/api/mixins/channels_spec.rb +24 -12
- data/spec/slack/web/api/mixins/conversations_list_spec.rb +21 -0
- data/spec/slack/web/api/mixins/conversations_spec.rb +43 -0
- data/spec/slack/web/api/mixins/groups_spec.rb +24 -12
- data/spec/slack/web/api/mixins/users_spec.rb +30 -17
- data/spec/slack/web/api/pagination/cursor_spec.rb +100 -0
- data/spec/slack/web/client_spec.rb +215 -14
- data/spec/slack/web/faraday/response/raise_error_spec.rb +85 -0
- data/spec/spec_helper.rb +8 -1
- data/spec/support/queue_with_timeout.rb +6 -5
- data/spec/support/real_time/concurrency/mock.rb +2 -2
- data/spec/support/real_time/connected_client.rb +13 -2
- data/spec/support/real_time/event.rb +1 -0
- data/spec/support/token.rb +1 -0
- data/spec/support/vcr.rb +6 -1
- metadata +280 -55
- data/examples/hi_real_time/Gemfile +0 -5
- data/examples/hi_real_time/hi.gif +0 -0
- data/examples/hi_real_time/hi.rb +0 -37
- data/examples/hi_real_time_async_celluloid/Gemfile +0 -6
- data/examples/hi_real_time_async_eventmachine/Procfile +0 -2
- data/examples/hi_real_time_async_eventmachine/hi.rb +0 -36
- data/lib/slack/real_time/concurrency/celluloid.rb +0 -113
- data/lib/slack/real_time/concurrency/eventmachine.rb +0 -60
- 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 -20
- data/screenshots/register-bot.png +0 -0
- data/spec/slack/real_time/concurrency/celluloid_spec.rb +0 -31
- data/spec/slack/real_time/concurrency/eventmachine_spec.rb +0 -47
data/RELEASING.md
CHANGED
@@ -13,12 +13,7 @@ rake
|
|
13
13
|
|
14
14
|
Check that the last build succeeded in [Travis CI](https://travis-ci.org/slack-ruby/slack-ruby-client) for all supported platforms.
|
15
15
|
|
16
|
-
|
17
|
-
|
18
|
-
* Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.2.1` to `0.2.2`).
|
19
|
-
* Increment the second number if the release contains major features or breaking API changes (eg. change `0.2.1` to `0.3.0`).
|
20
|
-
|
21
|
-
Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
|
16
|
+
Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the current date.
|
22
17
|
|
23
18
|
```
|
24
19
|
### 0.2.2 (7/10/2015)
|
@@ -26,12 +21,18 @@ Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
|
|
26
21
|
|
27
22
|
Remove the line with "Your contribution here.", since there will be no more contributions to this release.
|
28
23
|
|
29
|
-
|
24
|
+
In the "Stable Release" section of the README, change `**next**` to `**stable**` so users know that they are reading the documentation for a released version.
|
25
|
+
|
26
|
+
```
|
27
|
+
## Stable Release
|
28
|
+
|
29
|
+
You're reading the documentation for the **stable** release of slack-ruby-client, 0.2.2. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
|
30
|
+
```
|
30
31
|
|
31
32
|
Commit your changes.
|
32
33
|
|
33
34
|
```
|
34
|
-
git add README.md CHANGELOG.md
|
35
|
+
git add README.md CHANGELOG.md
|
35
36
|
git commit -m "Preparing for release, 0.2.2."
|
36
37
|
git push origin master
|
37
38
|
```
|
@@ -52,18 +53,25 @@ Pushed slack-ruby-client 0.2.2 to rubygems.org.
|
|
52
53
|
Add the next release to [CHANGELOG.md](CHANGELOG.md).
|
53
54
|
|
54
55
|
```
|
55
|
-
Next
|
56
|
-
============
|
56
|
+
### 0.2.3 (Next)
|
57
57
|
|
58
58
|
* Your contribution here.
|
59
59
|
```
|
60
60
|
|
61
61
|
Increment the third version number in [lib/slack/version.rb](lib/slack/version.rb).
|
62
62
|
|
63
|
+
Undo your change in README about the stable release.
|
64
|
+
|
65
|
+
```
|
66
|
+
## Stable Release
|
67
|
+
|
68
|
+
You're reading the documentation for the **next** release of slack-ruby-client. Please see the documentation for the [last stable release, v0.2.2](https://github.com/slack-ruby/slack-ruby-client/blob/v0.2.2/README.md) unless you're integrating with HEAD. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
|
69
|
+
```
|
70
|
+
|
63
71
|
Commit your changes.
|
64
72
|
|
65
73
|
```
|
66
|
-
git add CHANGELOG.md lib/slack/version.rb
|
74
|
+
git add README.md CHANGELOG.md lib/slack/version.rb
|
67
75
|
git commit -m "Preparing for next development iteration, 0.2.3."
|
68
76
|
git push origin master
|
69
77
|
```
|
data/Rakefile
CHANGED
@@ -1,3 +1,4 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
require 'rubygems'
|
2
3
|
require 'bundler'
|
3
4
|
require 'bundler/gem_tasks'
|
@@ -14,7 +15,7 @@ end
|
|
14
15
|
require 'rubocop/rake_task'
|
15
16
|
RuboCop::RakeTask.new
|
16
17
|
|
17
|
-
task default: [
|
18
|
+
task default: %i[spec rubocop]
|
18
19
|
|
19
20
|
load 'tasks/git.rake'
|
20
21
|
load 'tasks/web.rake'
|
data/UPGRADING.md
CHANGED
@@ -1,6 +1,90 @@
|
|
1
1
|
Upgrading Slack-Ruby-Client
|
2
2
|
===========================
|
3
3
|
|
4
|
+
### Upgrading to >= 0.16.0
|
5
|
+
|
6
|
+
#### Removed Celluloid and Faye-Websocket Concurrency Support
|
7
|
+
|
8
|
+
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).
|
9
|
+
|
10
|
+
See [#338](https://github.com/slack-ruby/slack-ruby-client/issues/338) for more information.
|
11
|
+
|
12
|
+
#### Error Handling
|
13
|
+
|
14
|
+
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.
|
15
|
+
|
16
|
+
See [README#other-errors](README.md#other-errors) and [#350](https://github.com/slack-ruby/slack-ruby-client/pull/350) for more information.
|
17
|
+
|
18
|
+
### Upgrading to >= 0.15.0
|
19
|
+
|
20
|
+
As of 0.15.0, `activesupport` is no longer required. Add `gem 'activesupport'` to your Gemfile if you required ActiveSupport via this library.
|
21
|
+
|
22
|
+
See [#325](https://github.com/slack-ruby/slack-ruby-client/pull/325) for more information.
|
23
|
+
|
24
|
+
### Upgrading to >= 0.14.0
|
25
|
+
|
26
|
+
If you are using async-websocket, lock down its version to 0.8.0 as newer versions are currently incompatible.
|
27
|
+
|
28
|
+
```
|
29
|
+
gem 'async-websocket', '~> 0.8.0'
|
30
|
+
```
|
31
|
+
|
32
|
+
See [#282](https://github.com/slack-ruby/slack-ruby-client/issues/282) for more information.
|
33
|
+
|
34
|
+
### Upgrading to >= 0.13.0
|
35
|
+
|
36
|
+
#### Recommended Async Library
|
37
|
+
|
38
|
+
The RealTime client now supports [async-websocket](https://github.com/socketry/async-websocket), which is actively maintained and is now the recommended library.
|
39
|
+
|
40
|
+
See [#219](https://github.com/slack-ruby/slack-ruby-client/pull/219) for implementation details.
|
41
|
+
|
42
|
+
#### Async Library Threading and Reactor Changes
|
43
|
+
|
44
|
+
The RealTime celluloid-io implementation now uses a `Thread` per client. Previous versions used an `Actor`.
|
45
|
+
|
46
|
+
The faye-websocket implementation with EventMachine will attempt to shutdown EventMachine via `EventMachine.stop` upon shutdown if a reactor wasn't already running.
|
47
|
+
|
48
|
+
See [#224](https://github.com/slack-ruby/slack-ruby-client/pull/224) for more information.
|
49
|
+
|
50
|
+
### Upgrading to >= 0.9.0
|
51
|
+
|
52
|
+
#### Changes in How the RTM Client Connects
|
53
|
+
|
54
|
+
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.
|
55
|
+
|
56
|
+
Prior versions always used `rtm.start`, to restore this behavior, configure `start_method`.
|
57
|
+
|
58
|
+
```ruby
|
59
|
+
Slack::RealTime::Client.config do |config|
|
60
|
+
config.start_method = :rtm_start
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
See [#145](https://github.com/slack-ruby/slack-ruby-client/pull/145) for more information.
|
65
|
+
|
66
|
+
### Upgrading to >= 0.8.0
|
67
|
+
|
68
|
+
The default timeout for `rtm.start` has been increased from 60 to 180 seconds via `Slack::RealTime::Client.config.start_options[:request][:timeout]`. If you're explicitly setting `start_options` in your application, preserve the value by merging settings instead of replacing the entire `start_options` value.
|
69
|
+
|
70
|
+
Before:
|
71
|
+
|
72
|
+
```ruby
|
73
|
+
Slack::RealTime::Client.config do |config|
|
74
|
+
config.start_options = { no_unreads: true }
|
75
|
+
end
|
76
|
+
```
|
77
|
+
|
78
|
+
After:
|
79
|
+
|
80
|
+
```ruby
|
81
|
+
Slack::RealTime::Client.config do |config|
|
82
|
+
config.start_options[:no_unreads] = true # keeps config.start_options[:request] intact
|
83
|
+
end
|
84
|
+
```
|
85
|
+
|
86
|
+
See [#136](https://github.com/slack-ruby/slack-ruby-client/pull/136) for more information.
|
87
|
+
|
4
88
|
### Upgrading to >= 0.6.0
|
5
89
|
|
6
90
|
#### Changes to API Response Data
|
@@ -60,5 +144,3 @@ gem 'celluloid-io'
|
|
60
144
|
When in doubt, use `faye-websocket`.
|
61
145
|
|
62
146
|
See [#5](https://github.com/slack-ruby/slack-ruby-client/issues/5) for more information.
|
63
|
-
|
64
|
-
|
data/bin/commands.rb
CHANGED
@@ -1,18 +1,56 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
# This file was auto-generated by lib/tasks/web.rake
|
2
3
|
|
4
|
+
require 'commands/admin_analytics'
|
5
|
+
require 'commands/admin_apps'
|
6
|
+
require 'commands/admin_apps_approved'
|
7
|
+
require 'commands/admin_apps_requests'
|
8
|
+
require 'commands/admin_apps_restricted'
|
9
|
+
require 'commands/admin_barriers'
|
10
|
+
require 'commands/admin_conversations'
|
11
|
+
require 'commands/admin_conversations_ekm'
|
12
|
+
require 'commands/admin_conversations_restrictAccess'
|
13
|
+
require 'commands/admin_conversations_whitelist'
|
14
|
+
require 'commands/admin_emoji'
|
15
|
+
require 'commands/admin_inviteRequests'
|
16
|
+
require 'commands/admin_inviteRequests_approved'
|
17
|
+
require 'commands/admin_inviteRequests_denied'
|
18
|
+
require 'commands/admin_teams'
|
19
|
+
require 'commands/admin_teams_admins'
|
20
|
+
require 'commands/admin_teams_owners'
|
21
|
+
require 'commands/admin_teams_settings'
|
22
|
+
require 'commands/admin_usergroups'
|
23
|
+
require 'commands/admin_users'
|
24
|
+
require 'commands/admin_users_session'
|
3
25
|
require 'commands/api'
|
26
|
+
require 'commands/apps'
|
27
|
+
require 'commands/apps_connections'
|
28
|
+
require 'commands/apps_event_authorizations'
|
29
|
+
require 'commands/apps_permissions'
|
30
|
+
require 'commands/apps_permissions_resources'
|
31
|
+
require 'commands/apps_permissions_scopes'
|
32
|
+
require 'commands/apps_permissions_users'
|
4
33
|
require 'commands/auth'
|
34
|
+
require 'commands/auth_teams'
|
5
35
|
require 'commands/bots'
|
36
|
+
require 'commands/calls'
|
37
|
+
require 'commands/calls_participants'
|
6
38
|
require 'commands/channels'
|
7
39
|
require 'commands/chat'
|
40
|
+
require 'commands/chat_scheduledMessages'
|
41
|
+
require 'commands/conversations'
|
42
|
+
require 'commands/dialog'
|
8
43
|
require 'commands/dnd'
|
9
44
|
require 'commands/emoji'
|
10
|
-
require 'commands/files_comments'
|
11
45
|
require 'commands/files'
|
46
|
+
require 'commands/files_comments'
|
47
|
+
require 'commands/files_remote'
|
12
48
|
require 'commands/groups'
|
13
49
|
require 'commands/im'
|
50
|
+
require 'commands/migration'
|
14
51
|
require 'commands/mpim'
|
15
52
|
require 'commands/oauth'
|
53
|
+
require 'commands/oauth_v2'
|
16
54
|
require 'commands/pins'
|
17
55
|
require 'commands/reactions'
|
18
56
|
require 'commands/reminders'
|
@@ -24,4 +62,8 @@ require 'commands/team_profile'
|
|
24
62
|
require 'commands/usergroups'
|
25
63
|
require 'commands/usergroups_users'
|
26
64
|
require 'commands/users'
|
65
|
+
require 'commands/users_admin'
|
66
|
+
require 'commands/users_prefs'
|
27
67
|
require 'commands/users_profile'
|
68
|
+
require 'commands/views'
|
69
|
+
require 'commands/workflows'
|
@@ -0,0 +1,15 @@
|
|
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.'
|
10
|
+
c.flag 'date', desc: 'Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC.'
|
11
|
+
c.action do |_global_options, options, _args|
|
12
|
+
puts JSON.dump($client.admin_analytics_getFile(options))
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminApps methods.'
|
5
|
+
command 'admin_apps' do |g|
|
6
|
+
g.desc 'Approve an app for installation on a workspace.'
|
7
|
+
g.long_desc %( Approve an app for installation on a workspace. )
|
8
|
+
g.command 'approve' do |c|
|
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.'
|
11
|
+
c.flag 'request_id', desc: 'The id of the request to approve.'
|
12
|
+
c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
|
13
|
+
c.action do |_global_options, options, _args|
|
14
|
+
puts JSON.dump($client.admin_apps_approve(options))
|
15
|
+
end
|
16
|
+
end
|
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
|
+
|
29
|
+
g.desc 'Restrict an app for installation on a workspace.'
|
30
|
+
g.long_desc %( Restrict an app for installation on a workspace. )
|
31
|
+
g.command 'restrict' do |c|
|
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.'
|
34
|
+
c.flag 'request_id', desc: 'The id of the request to restrict.'
|
35
|
+
c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
|
36
|
+
c.action do |_global_options, options, _args|
|
37
|
+
puts JSON.dump($client.admin_apps_restrict(options))
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminAppsApproved methods.'
|
5
|
+
command 'admin_apps_approved' do |g|
|
6
|
+
g.desc 'List approved apps for an org or workspace.'
|
7
|
+
g.long_desc %( List approved apps for an org or workspace. )
|
8
|
+
g.command 'list' do |c|
|
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: '.'
|
11
|
+
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
|
12
|
+
c.flag 'team_id', desc: '.'
|
13
|
+
c.action do |_global_options, options, _args|
|
14
|
+
puts JSON.dump($client.admin_apps_approved_list(options))
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminAppsRequests methods.'
|
5
|
+
command 'admin_apps_requests' do |g|
|
6
|
+
g.desc 'List app requests for a team/workspace.'
|
7
|
+
g.long_desc %( List app requests for a team/workspace. )
|
8
|
+
g.command 'list' do |c|
|
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 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
|
11
|
+
c.flag 'team_id', desc: '.'
|
12
|
+
c.action do |_global_options, options, _args|
|
13
|
+
puts JSON.dump($client.admin_apps_requests_list(options))
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminAppsRestricted methods.'
|
5
|
+
command 'admin_apps_restricted' do |g|
|
6
|
+
g.desc 'List restricted apps for an org or workspace.'
|
7
|
+
g.long_desc %( List restricted apps for an org or workspace. )
|
8
|
+
g.command 'list' do |c|
|
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: '.'
|
11
|
+
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
|
12
|
+
c.flag 'team_id', desc: '.'
|
13
|
+
c.action do |_global_options, options, _args|
|
14
|
+
puts JSON.dump($client.admin_apps_restricted_list(options))
|
15
|
+
end
|
16
|
+
end
|
17
|
+
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
|
@@ -0,0 +1,169 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminConversations methods.'
|
5
|
+
command 'admin_conversations' do |g|
|
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: 'The team to be removed from the channel. Currently only a single team id can be specified.'
|
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. )
|
151
|
+
g.command 'setTeams' do |c|
|
152
|
+
c.flag 'channel_id', desc: 'The encoded channel_id to add or remove to workspaces.'
|
153
|
+
c.flag 'org_channel', desc: 'True if channel has to be converted to an org channel.'
|
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.'
|
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.'
|
156
|
+
c.action do |_global_options, options, _args|
|
157
|
+
puts JSON.dump($client.admin_conversations_setTeams(options))
|
158
|
+
end
|
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
|
169
|
+
end
|