slack-ruby-client 0.14.6 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
|
3
|
+
|
|
4
|
+
module Slack
|
|
5
|
+
module Web
|
|
6
|
+
module Api
|
|
7
|
+
module Endpoints
|
|
8
|
+
module AdminConversationsEkm
|
|
9
|
+
#
|
|
10
|
+
# 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.
|
|
11
|
+
#
|
|
12
|
+
# @option options [string] :channel_ids
|
|
13
|
+
# A comma-separated list of channels to filter to.
|
|
14
|
+
# @option options [string] :cursor
|
|
15
|
+
# Set cursor to next_cursor returned by the previous call to list items in the next page.
|
|
16
|
+
# @option options [integer] :limit
|
|
17
|
+
# The maximum number of items to return. Must be between 1 - 1000 both inclusive.
|
|
18
|
+
# @option options [string] :team_ids
|
|
19
|
+
# A comma-separated list of the workspaces to which the channels you would like returned belong.
|
|
20
|
+
# @see https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
|
|
21
|
+
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.ekm/admin.conversations.ekm.listOriginalConnectedChannelInfo.json
|
|
22
|
+
def admin_conversations_ekm_listOriginalConnectedChannelInfo(options = {})
|
|
23
|
+
if block_given?
|
|
24
|
+
Pagination::Cursor.new(self, :admin_conversations_ekm_listOriginalConnectedChannelInfo, options).each do |page|
|
|
25
|
+
yield page
|
|
26
|
+
end
|
|
27
|
+
else
|
|
28
|
+
post('admin.conversations.ekm.listOriginalConnectedChannelInfo', options)
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
|
3
|
+
|
|
4
|
+
module Slack
|
|
5
|
+
module Web
|
|
6
|
+
module Api
|
|
7
|
+
module Endpoints
|
|
8
|
+
module AdminConversationsRestrictaccess
|
|
9
|
+
#
|
|
10
|
+
# Add an allowlist of IDP groups for accessing a channel
|
|
11
|
+
#
|
|
12
|
+
# @option options [Object] :channel_id
|
|
13
|
+
# The channel to link this group to.
|
|
14
|
+
# @option options [Object] :group_id
|
|
15
|
+
# The IDP Group ID to be an allowlist for the private channel.
|
|
16
|
+
# @option options [Object] :team_id
|
|
17
|
+
# 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.
|
|
18
|
+
# @see https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup
|
|
19
|
+
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.restrictAccess/admin.conversations.restrictAccess.addGroup.json
|
|
20
|
+
def admin_conversations_restrictAccess_addGroup(options = {})
|
|
21
|
+
throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
|
|
22
|
+
throw ArgumentError.new('Required arguments :group_id missing') if options[:group_id].nil?
|
|
23
|
+
post('admin.conversations.restrictAccess.addGroup', options)
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
#
|
|
27
|
+
# List all IDP Groups linked to a channel
|
|
28
|
+
#
|
|
29
|
+
# @option options [Object] :channel_id
|
|
30
|
+
# .
|
|
31
|
+
# @option options [Object] :team_id
|
|
32
|
+
# 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
|
+
# @see https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups
|
|
34
|
+
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.restrictAccess/admin.conversations.restrictAccess.listGroups.json
|
|
35
|
+
def admin_conversations_restrictAccess_listGroups(options = {})
|
|
36
|
+
throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
|
|
37
|
+
post('admin.conversations.restrictAccess.listGroups', options)
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
#
|
|
41
|
+
# Remove a linked IDP group linked from a private channel
|
|
42
|
+
#
|
|
43
|
+
# @option options [Object] :channel_id
|
|
44
|
+
# The channel to remove the linked group from.
|
|
45
|
+
# @option options [Object] :group_id
|
|
46
|
+
# The IDP Group ID to remove from the private channel.
|
|
47
|
+
# @option options [Object] :team_id
|
|
48
|
+
# 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.
|
|
49
|
+
# @see https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup
|
|
50
|
+
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.restrictAccess/admin.conversations.restrictAccess.removeGroup.json
|
|
51
|
+
def admin_conversations_restrictAccess_removeGroup(options = {})
|
|
52
|
+
throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
|
|
53
|
+
throw ArgumentError.new('Required arguments :group_id missing') if options[:group_id].nil?
|
|
54
|
+
throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
|
|
55
|
+
post('admin.conversations.restrictAccess.removeGroup', options)
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
61
|
+
end
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
|
3
|
+
|
|
4
|
+
module Slack
|
|
5
|
+
module Web
|
|
6
|
+
module Api
|
|
7
|
+
module Endpoints
|
|
8
|
+
module AdminConversationsWhitelist
|
|
9
|
+
#
|
|
10
|
+
# Add an allowlist of IDP groups for accessing a channel
|
|
11
|
+
#
|
|
12
|
+
# @option options [Object] :channel_id
|
|
13
|
+
# The channel to whitelist a group for.
|
|
14
|
+
# @option options [Object] :group_id
|
|
15
|
+
# The IDP Group ID to whitelist for the private channel.
|
|
16
|
+
# @option options [Object] :team_id
|
|
17
|
+
# The workspace where the IDP Group and channel exist.
|
|
18
|
+
# @see https://api.slack.com/methods/admin.conversations.whitelist.add
|
|
19
|
+
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.whitelist/admin.conversations.whitelist.add.json
|
|
20
|
+
def admin_conversations_whitelist_add(options = {})
|
|
21
|
+
throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
|
|
22
|
+
throw ArgumentError.new('Required arguments :group_id missing') if options[:group_id].nil?
|
|
23
|
+
logger.warn('admin.conversations.whitelist.add: This method is deprecated Alternative methods: .')
|
|
24
|
+
post('admin.conversations.whitelist.add', options)
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
#
|
|
28
|
+
# List all IDP Groups linked to a channel
|
|
29
|
+
#
|
|
30
|
+
# @option options [Object] :channel_id
|
|
31
|
+
# .
|
|
32
|
+
# @option options [Object] :team_id
|
|
33
|
+
# 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.
|
|
34
|
+
# @see https://api.slack.com/methods/admin.conversations.whitelist.listGroupsLinkedToChannel
|
|
35
|
+
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.whitelist/admin.conversations.whitelist.listGroupsLinkedToChannel.json
|
|
36
|
+
def admin_conversations_whitelist_listGroupsLinkedToChannel(options = {})
|
|
37
|
+
throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
|
|
38
|
+
logger.warn('admin.conversations.whitelist.listGroupsLinkedToChannel: This method is deprecated Alternative methods: .')
|
|
39
|
+
post('admin.conversations.whitelist.listGroupsLinkedToChannel', options)
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
#
|
|
43
|
+
# Remove an allowlisted IDP group linked to a private channel
|
|
44
|
+
#
|
|
45
|
+
# @option options [Object] :channel_id
|
|
46
|
+
# The channel to remove a whitelisted group for.
|
|
47
|
+
# @option options [Object] :group_id
|
|
48
|
+
# The IDP Group ID to remove from the private channel whitelist.
|
|
49
|
+
# @option options [Object] :team_id
|
|
50
|
+
# The workspace where the IDP Group and channel exist.
|
|
51
|
+
# @see https://api.slack.com/methods/admin.conversations.whitelist.remove
|
|
52
|
+
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.whitelist/admin.conversations.whitelist.remove.json
|
|
53
|
+
def admin_conversations_whitelist_remove(options = {})
|
|
54
|
+
throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
|
|
55
|
+
throw ArgumentError.new('Required arguments :group_id missing') if options[:group_id].nil?
|
|
56
|
+
throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
|
|
57
|
+
logger.warn('admin.conversations.whitelist.remove: This method is deprecated Alternative methods: .')
|
|
58
|
+
post('admin.conversations.whitelist.remove', options)
|
|
59
|
+
end
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
@@ -9,9 +9,9 @@ module Slack
|
|
|
9
9
|
#
|
|
10
10
|
# Add an emoji.
|
|
11
11
|
#
|
|
12
|
-
# @option options [
|
|
13
|
-
# The name of the emoji to be
|
|
14
|
-
# @option options [
|
|
12
|
+
# @option options [string] :name
|
|
13
|
+
# The name of the emoji to be added. Colons (:myemoji:) around the value are not required, although they may be included.
|
|
14
|
+
# @option options [string] :url
|
|
15
15
|
# The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best.
|
|
16
16
|
# @see https://api.slack.com/methods/admin.emoji.add
|
|
17
17
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.emoji/admin.emoji.add.json
|
|
@@ -24,9 +24,9 @@ module Slack
|
|
|
24
24
|
#
|
|
25
25
|
# Add an emoji alias.
|
|
26
26
|
#
|
|
27
|
-
# @option options [
|
|
27
|
+
# @option options [string] :alias_for
|
|
28
28
|
# The alias of the emoji.
|
|
29
|
-
# @option options [
|
|
29
|
+
# @option options [string] :name
|
|
30
30
|
# The name of the emoji to be aliased. Colons (:myemoji:) around the value are not required, although they may be included.
|
|
31
31
|
# @see https://api.slack.com/methods/admin.emoji.addAlias
|
|
32
32
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.emoji/admin.emoji.addAlias.json
|
|
@@ -39,9 +39,9 @@ module Slack
|
|
|
39
39
|
#
|
|
40
40
|
# List emoji for an Enterprise Grid organization.
|
|
41
41
|
#
|
|
42
|
-
# @option options [
|
|
42
|
+
# @option options [string] :cursor
|
|
43
43
|
# Set cursor to next_cursor returned by the previous call to list items in the next page.
|
|
44
|
-
# @option options [
|
|
44
|
+
# @option options [integer] :limit
|
|
45
45
|
# The maximum number of items to return. Must be between 1 - 1000 both inclusive.
|
|
46
46
|
# @see https://api.slack.com/methods/admin.emoji.list
|
|
47
47
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.emoji/admin.emoji.list.json
|
|
@@ -58,7 +58,7 @@ module Slack
|
|
|
58
58
|
#
|
|
59
59
|
# Remove an emoji across an Enterprise Grid organization
|
|
60
60
|
#
|
|
61
|
-
# @option options [
|
|
61
|
+
# @option options [string] :name
|
|
62
62
|
# The name of the emoji to be removed. Colons (:myemoji:) around the value are not required, although they may be included.
|
|
63
63
|
# @see https://api.slack.com/methods/admin.emoji.remove
|
|
64
64
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.emoji/admin.emoji.remove.json
|
|
@@ -70,9 +70,9 @@ module Slack
|
|
|
70
70
|
#
|
|
71
71
|
# Rename an emoji.
|
|
72
72
|
#
|
|
73
|
-
# @option options [
|
|
73
|
+
# @option options [string] :name
|
|
74
74
|
# The name of the emoji to be renamed. Colons (:myemoji:) around the value are not required, although they may be included.
|
|
75
|
-
# @option options [
|
|
75
|
+
# @option options [string] :new_name
|
|
76
76
|
# The new name of the emoji.
|
|
77
77
|
# @see https://api.slack.com/methods/admin.emoji.rename
|
|
78
78
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.emoji/admin.emoji.rename.json
|
|
@@ -9,9 +9,9 @@ module Slack
|
|
|
9
9
|
#
|
|
10
10
|
# Approve a workspace invite request.
|
|
11
11
|
#
|
|
12
|
-
# @option options [
|
|
12
|
+
# @option options [string] :invite_request_id
|
|
13
13
|
# ID of the request to invite.
|
|
14
|
-
# @option options [
|
|
14
|
+
# @option options [string] :team_id
|
|
15
15
|
# ID for the workspace where the invite request was made.
|
|
16
16
|
# @see https://api.slack.com/methods/admin.inviteRequests.approve
|
|
17
17
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.inviteRequests/admin.inviteRequests.approve.json
|
|
@@ -23,9 +23,9 @@ module Slack
|
|
|
23
23
|
#
|
|
24
24
|
# Deny a workspace invite request.
|
|
25
25
|
#
|
|
26
|
-
# @option options [
|
|
26
|
+
# @option options [string] :invite_request_id
|
|
27
27
|
# ID of the request to invite.
|
|
28
|
-
# @option options [
|
|
28
|
+
# @option options [string] :team_id
|
|
29
29
|
# ID for the workspace where the invite request was made.
|
|
30
30
|
# @see https://api.slack.com/methods/admin.inviteRequests.deny
|
|
31
31
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.inviteRequests/admin.inviteRequests.deny.json
|
|
@@ -37,11 +37,11 @@ module Slack
|
|
|
37
37
|
#
|
|
38
38
|
# List all pending workspace invite requests.
|
|
39
39
|
#
|
|
40
|
-
# @option options [
|
|
40
|
+
# @option options [string] :cursor
|
|
41
41
|
# Value of the next_cursor field sent as part of the previous API response.
|
|
42
|
-
# @option options [
|
|
42
|
+
# @option options [integer] :limit
|
|
43
43
|
# The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive.
|
|
44
|
-
# @option options [
|
|
44
|
+
# @option options [string] :team_id
|
|
45
45
|
# ID for the workspace where the invite requests were made.
|
|
46
46
|
# @see https://api.slack.com/methods/admin.inviteRequests.list
|
|
47
47
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.inviteRequests/admin.inviteRequests.list.json
|
|
@@ -9,11 +9,11 @@ module Slack
|
|
|
9
9
|
#
|
|
10
10
|
# List all approved workspace invite requests.
|
|
11
11
|
#
|
|
12
|
-
# @option options [
|
|
12
|
+
# @option options [string] :cursor
|
|
13
13
|
# Value of the next_cursor field sent as part of the previous API response.
|
|
14
|
-
# @option options [
|
|
14
|
+
# @option options [integer] :limit
|
|
15
15
|
# The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive.
|
|
16
|
-
# @option options [
|
|
16
|
+
# @option options [string] :team_id
|
|
17
17
|
# ID for the workspace where the invite requests were made.
|
|
18
18
|
# @see https://api.slack.com/methods/admin.inviteRequests.approved.list
|
|
19
19
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.inviteRequests.approved/admin.inviteRequests.approved.list.json
|
|
@@ -9,9 +9,9 @@ module Slack
|
|
|
9
9
|
#
|
|
10
10
|
# List all denied workspace invite requests.
|
|
11
11
|
#
|
|
12
|
-
# @option options [
|
|
12
|
+
# @option options [string] :cursor
|
|
13
13
|
# Value of the next_cursor field sent as part of the previous api response.
|
|
14
|
-
# @option options [
|
|
14
|
+
# @option options [integer] :limit
|
|
15
15
|
# The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive.
|
|
16
16
|
# @option options [Object] :team_id
|
|
17
17
|
# ID for the workspace where the invite requests were made.
|
|
@@ -9,13 +9,13 @@ module Slack
|
|
|
9
9
|
#
|
|
10
10
|
# Create an Enterprise team.
|
|
11
11
|
#
|
|
12
|
-
# @option options [
|
|
13
|
-
# Team domain (for example, slacksoftballteam).
|
|
14
|
-
# @option options [
|
|
12
|
+
# @option options [string] :team_domain
|
|
13
|
+
# Team domain (for example, slacksoftballteam). Domains are limited to 21 characters.
|
|
14
|
+
# @option options [string] :team_name
|
|
15
15
|
# Team name (for example, Slack Softball Team).
|
|
16
|
-
# @option options [
|
|
16
|
+
# @option options [string] :team_description
|
|
17
17
|
# Description for the team.
|
|
18
|
-
# @option options [
|
|
18
|
+
# @option options [string] :team_discoverability
|
|
19
19
|
# Who can join the team. A team's discoverability can be open, closed, invite_only, or unlisted.
|
|
20
20
|
# @see https://api.slack.com/methods/admin.teams.create
|
|
21
21
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams/admin.teams.create.json
|
|
@@ -28,9 +28,9 @@ module Slack
|
|
|
28
28
|
#
|
|
29
29
|
# List all teams on an Enterprise organization
|
|
30
30
|
#
|
|
31
|
-
# @option options [
|
|
31
|
+
# @option options [string] :cursor
|
|
32
32
|
# Set cursor to next_cursor returned by the previous call to list items in the next page.
|
|
33
|
-
# @option options [
|
|
33
|
+
# @option options [integer] :limit
|
|
34
34
|
# The maximum number of items to return. Must be between 1 - 100 both inclusive.
|
|
35
35
|
# @see https://api.slack.com/methods/admin.teams.list
|
|
36
36
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams/admin.teams.list.json
|
|
@@ -11,9 +11,9 @@ module Slack
|
|
|
11
11
|
#
|
|
12
12
|
# @option options [Object] :team_id
|
|
13
13
|
# .
|
|
14
|
-
# @option options [
|
|
14
|
+
# @option options [string] :cursor
|
|
15
15
|
# Set cursor to next_cursor returned by the previous call to list items in the next page.
|
|
16
|
-
# @option options [
|
|
16
|
+
# @option options [integer] :limit
|
|
17
17
|
# The maximum number of items to return.
|
|
18
18
|
# @see https://api.slack.com/methods/admin.teams.admins.list
|
|
19
19
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.admins/admin.teams.admins.list.json
|
|
@@ -11,9 +11,9 @@ module Slack
|
|
|
11
11
|
#
|
|
12
12
|
# @option options [Object] :team_id
|
|
13
13
|
# .
|
|
14
|
-
# @option options [
|
|
14
|
+
# @option options [string] :cursor
|
|
15
15
|
# Set cursor to next_cursor returned by the previous call to list items in the next page.
|
|
16
|
-
# @option options [
|
|
16
|
+
# @option options [integer] :limit
|
|
17
17
|
# The maximum number of items to return. Must be between 1 - 1000 both inclusive.
|
|
18
18
|
# @see https://api.slack.com/methods/admin.teams.owners.list
|
|
19
19
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.owners/admin.teams.owners.list.json
|
|
@@ -21,7 +21,7 @@ module Slack
|
|
|
21
21
|
#
|
|
22
22
|
# Set the default channels of a workspace.
|
|
23
23
|
#
|
|
24
|
-
# @option options [
|
|
24
|
+
# @option options [array] :channel_ids
|
|
25
25
|
# An array of channel IDs.
|
|
26
26
|
# @option options [Object] :team_id
|
|
27
27
|
# ID for the workspace to set the default channel for.
|
|
@@ -36,7 +36,7 @@ module Slack
|
|
|
36
36
|
#
|
|
37
37
|
# Set the description of a given workspace.
|
|
38
38
|
#
|
|
39
|
-
# @option options [
|
|
39
|
+
# @option options [string] :description
|
|
40
40
|
# The new description for the workspace.
|
|
41
41
|
# @option options [Object] :team_id
|
|
42
42
|
# ID for the workspace to set the description for.
|
|
@@ -51,7 +51,7 @@ module Slack
|
|
|
51
51
|
#
|
|
52
52
|
# An API method that allows admins to set the discoverability of a given workspace
|
|
53
53
|
#
|
|
54
|
-
# @option options [
|
|
54
|
+
# @option options [string] :discoverability
|
|
55
55
|
# This workspace's discovery setting. It must be set to one of open, invite_only, closed, or unlisted.
|
|
56
56
|
# @option options [Object] :team_id
|
|
57
57
|
# The ID of the workspace to set discoverability on.
|
|
@@ -66,7 +66,7 @@ module Slack
|
|
|
66
66
|
#
|
|
67
67
|
# Sets the icon of a workspace.
|
|
68
68
|
#
|
|
69
|
-
# @option options [
|
|
69
|
+
# @option options [string] :image_url
|
|
70
70
|
# Image URL for the icon.
|
|
71
71
|
# @option options [Object] :team_id
|
|
72
72
|
# ID for the workspace to set the icon for.
|
|
@@ -81,7 +81,7 @@ module Slack
|
|
|
81
81
|
#
|
|
82
82
|
# Set the name of a given workspace.
|
|
83
83
|
#
|
|
84
|
-
# @option options [
|
|
84
|
+
# @option options [string] :name
|
|
85
85
|
# The new name of the workspace.
|
|
86
86
|
# @option options [Object] :team_id
|
|
87
87
|
# ID for the workspace to set the name for.
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
|
3
|
+
|
|
4
|
+
module Slack
|
|
5
|
+
module Web
|
|
6
|
+
module Api
|
|
7
|
+
module Endpoints
|
|
8
|
+
module AdminUsergroups
|
|
9
|
+
#
|
|
10
|
+
# Add up to one hundred default channels to an IDP group.
|
|
11
|
+
#
|
|
12
|
+
# @option options [array] :channel_ids
|
|
13
|
+
# Comma separated string of channel IDs.
|
|
14
|
+
# @option options [string] :usergroup_id
|
|
15
|
+
# ID of the IDP group to add default channels for.
|
|
16
|
+
# @option options [string] :team_id
|
|
17
|
+
# The workspace to add default channels in.
|
|
18
|
+
# @see https://api.slack.com/methods/admin.usergroups.addChannels
|
|
19
|
+
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.addChannels.json
|
|
20
|
+
def admin_usergroups_addChannels(options = {})
|
|
21
|
+
throw ArgumentError.new('Required arguments :channel_ids missing') if options[:channel_ids].nil?
|
|
22
|
+
throw ArgumentError.new('Required arguments :usergroup_id missing') if options[:usergroup_id].nil?
|
|
23
|
+
post('admin.usergroups.addChannels', options)
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
#
|
|
27
|
+
# Associate one or more default workspaces with an organization-wide IDP group.
|
|
28
|
+
#
|
|
29
|
+
# @option options [array] :team_ids
|
|
30
|
+
# A comma separated list of encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token.
|
|
31
|
+
# @option options [string] :usergroup_id
|
|
32
|
+
# An encoded usergroup (IDP Group) ID.
|
|
33
|
+
# @option options [boolean] :auto_provision
|
|
34
|
+
# When true, this method automatically creates new workspace accounts for the IDP group members.
|
|
35
|
+
# @see https://api.slack.com/methods/admin.usergroups.addTeams
|
|
36
|
+
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.addTeams.json
|
|
37
|
+
def admin_usergroups_addTeams(options = {})
|
|
38
|
+
throw ArgumentError.new('Required arguments :team_ids missing') if options[:team_ids].nil?
|
|
39
|
+
throw ArgumentError.new('Required arguments :usergroup_id missing') if options[:usergroup_id].nil?
|
|
40
|
+
post('admin.usergroups.addTeams', options)
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
#
|
|
44
|
+
# List the channels linked to an org-level IDP group (user group).
|
|
45
|
+
#
|
|
46
|
+
# @option options [Object] :usergroup_id
|
|
47
|
+
# ID of the IDP group to list default channels for.
|
|
48
|
+
# @option options [boolean] :include_num_members
|
|
49
|
+
# Flag to include or exclude the count of members per channel.
|
|
50
|
+
# @option options [string] :team_id
|
|
51
|
+
# ID of the the workspace.
|
|
52
|
+
# @see https://api.slack.com/methods/admin.usergroups.listChannels
|
|
53
|
+
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.listChannels.json
|
|
54
|
+
def admin_usergroups_listChannels(options = {})
|
|
55
|
+
throw ArgumentError.new('Required arguments :usergroup_id missing') if options[:usergroup_id].nil?
|
|
56
|
+
post('admin.usergroups.listChannels', options)
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
#
|
|
60
|
+
# Remove one or more default channels from an org-level IDP group (user group).
|
|
61
|
+
#
|
|
62
|
+
# @option options [array] :channel_ids
|
|
63
|
+
# Comma-separated string of channel IDs.
|
|
64
|
+
# @option options [string] :usergroup_id
|
|
65
|
+
# ID of the IDP Group.
|
|
66
|
+
# @see https://api.slack.com/methods/admin.usergroups.removeChannels
|
|
67
|
+
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.removeChannels.json
|
|
68
|
+
def admin_usergroups_removeChannels(options = {})
|
|
69
|
+
throw ArgumentError.new('Required arguments :channel_ids missing') if options[:channel_ids].nil?
|
|
70
|
+
throw ArgumentError.new('Required arguments :usergroup_id missing') if options[:usergroup_id].nil?
|
|
71
|
+
post('admin.usergroups.removeChannels', options)
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
end
|
|
@@ -13,11 +13,11 @@ module Slack
|
|
|
13
13
|
# The ID (T1234) of the workspace.
|
|
14
14
|
# @option options [Object] :user_id
|
|
15
15
|
# The ID of the user to add to the workspace.
|
|
16
|
-
# @option options [
|
|
16
|
+
# @option options [string] :channel_ids
|
|
17
17
|
# Comma separated values of channel IDs to add user in the new workspace.
|
|
18
|
-
# @option options [
|
|
18
|
+
# @option options [boolean] :is_restricted
|
|
19
19
|
# True if user should be added to the workspace as a guest.
|
|
20
|
-
# @option options [
|
|
20
|
+
# @option options [boolean] :is_ultra_restricted
|
|
21
21
|
# True if user should be added to the workspace as a single-channel guest.
|
|
22
22
|
# @see https://api.slack.com/methods/admin.users.assign
|
|
23
23
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.assign.json
|
|
@@ -30,23 +30,25 @@ module Slack
|
|
|
30
30
|
#
|
|
31
31
|
# Invite a user to a workspace.
|
|
32
32
|
#
|
|
33
|
-
# @option options [
|
|
33
|
+
# @option options [string] :channel_ids
|
|
34
34
|
# A comma-separated list of channel_ids for this user to join. At least one channel is required.
|
|
35
|
-
# @option options [
|
|
35
|
+
# @option options [string] :email
|
|
36
36
|
# The email address of the person to invite.
|
|
37
37
|
# @option options [Object] :team_id
|
|
38
38
|
# The ID (T1234) of the workspace.
|
|
39
|
-
# @option options [
|
|
39
|
+
# @option options [string] :custom_message
|
|
40
40
|
# An optional message to send to the user in the invite email.
|
|
41
|
-
# @option options [
|
|
41
|
+
# @option options [boolean] :email_password_policy_enabled
|
|
42
|
+
# Allow invited user to sign in via email and password. Only available for Enterprise Grid teams via admin invite.
|
|
43
|
+
# @option options [string] :guest_expiration_ts
|
|
42
44
|
# 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.
|
|
43
|
-
# @option options [
|
|
45
|
+
# @option options [boolean] :is_restricted
|
|
44
46
|
# Is this user a multi-channel guest user? (default: false).
|
|
45
|
-
# @option options [
|
|
47
|
+
# @option options [boolean] :is_ultra_restricted
|
|
46
48
|
# Is this user a single channel guest user? (default: false).
|
|
47
|
-
# @option options [
|
|
49
|
+
# @option options [string] :real_name
|
|
48
50
|
# Full name of the user.
|
|
49
|
-
# @option options [
|
|
51
|
+
# @option options [boolean] :resend
|
|
50
52
|
# Allow this invite to be resent in the future if a user has not signed up yet. (default: false).
|
|
51
53
|
# @see https://api.slack.com/methods/admin.users.invite
|
|
52
54
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.invite.json
|
|
@@ -60,16 +62,15 @@ module Slack
|
|
|
60
62
|
#
|
|
61
63
|
# List users on a workspace
|
|
62
64
|
#
|
|
63
|
-
# @option options [
|
|
64
|
-
# The ID (T1234) of the workspace.
|
|
65
|
-
# @option options [Object] :cursor
|
|
65
|
+
# @option options [string] :cursor
|
|
66
66
|
# Set cursor to next_cursor returned by the previous call to list items in the next page.
|
|
67
|
-
# @option options [
|
|
67
|
+
# @option options [integer] :limit
|
|
68
68
|
# Limit for how many users to be retrieved per page.
|
|
69
|
+
# @option options [Object] :team_id
|
|
70
|
+
# The ID (T1234) of the workspace.
|
|
69
71
|
# @see https://api.slack.com/methods/admin.users.list
|
|
70
72
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.list.json
|
|
71
73
|
def admin_users_list(options = {})
|
|
72
|
-
throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
|
|
73
74
|
if block_given?
|
|
74
75
|
Pagination::Cursor.new(self, :admin_users_list, options).each do |page|
|
|
75
76
|
yield page
|
|
@@ -84,7 +85,7 @@ module Slack
|
|
|
84
85
|
#
|
|
85
86
|
# @option options [Object] :team_id
|
|
86
87
|
# The ID (T1234) of the workspace.
|
|
87
|
-
# @option options [
|
|
88
|
+
# @option options [string] :user_id
|
|
88
89
|
# The ID of the user to remove.
|
|
89
90
|
# @see https://api.slack.com/methods/admin.users.remove
|
|
90
91
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.remove.json
|
|
@@ -99,7 +100,7 @@ module Slack
|
|
|
99
100
|
#
|
|
100
101
|
# @option options [Object] :team_id
|
|
101
102
|
# The ID (T1234) of the workspace.
|
|
102
|
-
# @option options [
|
|
103
|
+
# @option options [string] :user_id
|
|
103
104
|
# The ID of the user to designate as an admin.
|
|
104
105
|
# @see https://api.slack.com/methods/admin.users.setAdmin
|
|
105
106
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setAdmin.json
|
|
@@ -112,17 +113,16 @@ module Slack
|
|
|
112
113
|
#
|
|
113
114
|
# Set an expiration for a guest user
|
|
114
115
|
#
|
|
115
|
-
# @option options [
|
|
116
|
+
# @option options [integer] :expiration_ts
|
|
116
117
|
# Timestamp when guest account should be disabled.
|
|
118
|
+
# @option options [string] :user_id
|
|
119
|
+
# The ID of the user to set an expiration for.
|
|
117
120
|
# @option options [Object] :team_id
|
|
118
121
|
# The ID (T1234) of the workspace.
|
|
119
|
-
# @option options [Object] :user_id
|
|
120
|
-
# The ID of the user to set an expiration for.
|
|
121
122
|
# @see https://api.slack.com/methods/admin.users.setExpiration
|
|
122
123
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setExpiration.json
|
|
123
124
|
def admin_users_setExpiration(options = {})
|
|
124
125
|
throw ArgumentError.new('Required arguments :expiration_ts missing') if options[:expiration_ts].nil?
|
|
125
|
-
throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
|
|
126
126
|
throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
|
|
127
127
|
post('admin.users.setExpiration', options)
|
|
128
128
|
end
|
|
@@ -147,7 +147,7 @@ module Slack
|
|
|
147
147
|
#
|
|
148
148
|
# @option options [Object] :team_id
|
|
149
149
|
# The ID (T1234) of the workspace.
|
|
150
|
-
# @option options [
|
|
150
|
+
# @option options [string] :user_id
|
|
151
151
|
# The ID of the user to designate as a regular user.
|
|
152
152
|
# @see https://api.slack.com/methods/admin.users.setRegular
|
|
153
153
|
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setRegular.json
|