slack-ruby-client 0.15.0 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (264) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +6 -1
  3. data/.rubocop_todo.yml +75 -43
  4. data/.travis.yml +2 -4
  5. data/CHANGELOG.md +32 -0
  6. data/CONTRIBUTING.md +6 -13
  7. data/LICENSE.md +1 -1
  8. data/README.md +19 -36
  9. data/RELEASING.md +1 -1
  10. data/UPGRADING.md +56 -2
  11. data/bin/commands/admin_analytics.rb +16 -0
  12. data/bin/commands/admin_apps.rb +26 -2
  13. data/bin/commands/admin_apps_requests.rb +1 -0
  14. data/bin/commands/admin_auth_policy.rb +39 -0
  15. data/bin/commands/admin_barriers.rb +47 -0
  16. data/bin/commands/admin_conversations.rb +154 -2
  17. data/bin/commands/admin_conversations_ekm.rb +17 -0
  18. data/bin/commands/admin_conversations_restrictAccess.rb +3 -3
  19. data/bin/commands/admin_conversations_whitelist.rb +1 -1
  20. data/bin/commands/admin_emoji.rb +1 -1
  21. data/bin/commands/admin_teams.rb +1 -1
  22. data/bin/commands/admin_usergroups.rb +2 -2
  23. data/bin/commands/admin_users.rb +3 -2
  24. data/bin/commands/admin_users_session.rb +62 -0
  25. data/bin/commands/api.rb +0 -1
  26. data/bin/commands/apps_connections.rb +13 -0
  27. data/bin/commands/apps_event_authorizations.rb +16 -0
  28. data/bin/commands/apps_manifest.rb +51 -0
  29. data/bin/commands/auth_teams.rb +16 -0
  30. data/bin/commands/bots.rb +1 -0
  31. data/bin/commands/channels.rb +1 -155
  32. data/bin/commands/chat.rb +12 -7
  33. data/bin/commands/chat_scheduledMessages.rb +1 -0
  34. data/bin/commands/conversations.rb +71 -2
  35. data/bin/commands/dnd.rb +2 -0
  36. data/bin/commands/files.rb +6 -4
  37. data/bin/commands/files_remote.rb +2 -2
  38. data/bin/commands/groups.rb +1 -162
  39. data/bin/commands/im.rb +1 -63
  40. data/bin/commands/migration.rb +1 -0
  41. data/bin/commands/mpim.rb +1 -61
  42. data/bin/commands/oauth.rb +0 -13
  43. data/bin/commands/oauth_v2.rb +13 -1
  44. data/bin/commands/openid_connect.rb +27 -0
  45. data/bin/commands/pins.rb +2 -4
  46. data/bin/commands/reactions.rb +1 -0
  47. data/bin/commands/reminders.rb +6 -0
  48. data/bin/commands/rtm.rb +2 -2
  49. data/bin/commands/search.rb +4 -0
  50. data/bin/commands/stars.rb +7 -6
  51. data/bin/commands/team.rb +3 -0
  52. data/bin/commands/team_billing.rb +13 -0
  53. data/bin/commands/team_preferences.rb +13 -0
  54. data/bin/commands/tooling_tokens.rb +14 -0
  55. data/bin/commands/usergroups.rb +5 -0
  56. data/bin/commands/usergroups_users.rb +2 -0
  57. data/bin/commands/users.rb +4 -2
  58. data/bin/commands/users_profile.rb +5 -5
  59. data/bin/commands/views.rb +2 -2
  60. data/bin/commands/workflows.rb +38 -0
  61. data/bin/commands.rb +13 -9
  62. data/lib/slack/config.rb +1 -2
  63. data/lib/slack/events/request.rb +10 -4
  64. data/lib/slack/real_time/client.rb +6 -6
  65. data/lib/slack/real_time/concurrency/async.rb +6 -8
  66. data/lib/slack/real_time/concurrency.rb +0 -2
  67. data/lib/slack/real_time/config.rb +5 -14
  68. data/lib/slack/real_time/socket.rb +1 -2
  69. data/lib/slack/real_time/stores/base.rb +1 -6
  70. data/lib/slack/real_time/stores/starter.rb +6 -3
  71. data/lib/slack/real_time/stores/store.rb +5 -0
  72. data/lib/slack/version.rb +1 -1
  73. data/lib/slack/web/api/endpoints/admin_analytics.rb +28 -0
  74. data/lib/slack/web/api/endpoints/admin_apps.rb +42 -6
  75. data/lib/slack/web/api/endpoints/admin_apps_approved.rb +2 -2
  76. data/lib/slack/web/api/endpoints/admin_apps_requests.rb +4 -2
  77. data/lib/slack/web/api/endpoints/admin_apps_restricted.rb +2 -2
  78. data/lib/slack/web/api/endpoints/admin_auth_policy.rb +72 -0
  79. data/lib/slack/web/api/endpoints/admin_barriers.rb +82 -0
  80. data/lib/slack/web/api/endpoints/admin_conversations.rb +233 -3
  81. data/lib/slack/web/api/endpoints/admin_conversations_ekm.rb +35 -0
  82. data/lib/slack/web/api/endpoints/admin_conversations_restrictAccess.rb +3 -3
  83. data/lib/slack/web/api/endpoints/admin_conversations_whitelist.rb +3 -3
  84. data/lib/slack/web/api/endpoints/admin_emoji.rb +10 -10
  85. data/lib/slack/web/api/endpoints/admin_inviteRequests.rb +7 -7
  86. data/lib/slack/web/api/endpoints/admin_inviteRequests_approved.rb +3 -3
  87. data/lib/slack/web/api/endpoints/admin_inviteRequests_denied.rb +2 -2
  88. data/lib/slack/web/api/endpoints/admin_teams.rb +7 -7
  89. data/lib/slack/web/api/endpoints/admin_teams_admins.rb +2 -2
  90. data/lib/slack/web/api/endpoints/admin_teams_owners.rb +2 -2
  91. data/lib/slack/web/api/endpoints/admin_teams_settings.rb +5 -5
  92. data/lib/slack/web/api/endpoints/admin_usergroups.rb +11 -11
  93. data/lib/slack/web/api/endpoints/admin_users.rb +23 -23
  94. data/lib/slack/web/api/endpoints/admin_users_session.rb +97 -3
  95. data/lib/slack/web/api/endpoints/api.rb +1 -3
  96. data/lib/slack/web/api/endpoints/apps.rb +2 -2
  97. data/lib/slack/web/api/endpoints/apps_connections.rb +21 -0
  98. data/lib/slack/web/api/endpoints/apps_event_authorizations.rb +34 -0
  99. data/lib/slack/web/api/endpoints/apps_manifest.rb +75 -0
  100. data/lib/slack/web/api/endpoints/auth.rb +1 -1
  101. data/lib/slack/web/api/endpoints/auth_teams.rb +33 -0
  102. data/lib/slack/web/api/endpoints/bots.rb +3 -1
  103. data/lib/slack/web/api/endpoints/calls.rb +15 -15
  104. data/lib/slack/web/api/endpoints/calls_participants.rb +4 -4
  105. data/lib/slack/web/api/endpoints/channels.rb +0 -259
  106. data/lib/slack/web/api/endpoints/chat.rb +65 -55
  107. data/lib/slack/web/api/endpoints/chat_scheduledMessages.rb +4 -2
  108. data/lib/slack/web/api/endpoints/conversations.rb +134 -24
  109. data/lib/slack/web/api/endpoints/dialog.rb +2 -2
  110. data/lib/slack/web/api/endpoints/dnd.rb +6 -3
  111. data/lib/slack/web/api/endpoints/files.rb +19 -15
  112. data/lib/slack/web/api/endpoints/files_comments.rb +1 -1
  113. data/lib/slack/web/api/endpoints/files_remote.rb +22 -22
  114. data/lib/slack/web/api/endpoints/groups.rb +0 -269
  115. data/lib/slack/web/api/endpoints/im.rb +0 -107
  116. data/lib/slack/web/api/endpoints/migration.rb +4 -2
  117. data/lib/slack/web/api/endpoints/mpim.rb +0 -102
  118. data/lib/slack/web/api/endpoints/oauth.rb +5 -27
  119. data/lib/slack/web/api/endpoints/oauth_v2.rb +24 -6
  120. data/lib/slack/web/api/endpoints/openid_connect.rb +42 -0
  121. data/lib/slack/web/api/endpoints/pins.rb +4 -9
  122. data/lib/slack/web/api/endpoints/reactions.rb +13 -11
  123. data/lib/slack/web/api/endpoints/reminders.rb +17 -5
  124. data/lib/slack/web/api/endpoints/rtm.rb +10 -10
  125. data/lib/slack/web/api/endpoints/search.rb +27 -13
  126. data/lib/slack/web/api/endpoints/stars.rb +11 -9
  127. data/lib/slack/web/api/endpoints/team.rb +11 -5
  128. data/lib/slack/web/api/endpoints/team_billing.rb +21 -0
  129. data/lib/slack/web/api/endpoints/team_preferences.rb +21 -0
  130. data/lib/slack/web/api/endpoints/team_profile.rb +1 -1
  131. data/lib/slack/web/api/endpoints/tooling_tokens.rb +24 -0
  132. data/lib/slack/web/api/endpoints/usergroups.rb +26 -16
  133. data/lib/slack/web/api/endpoints/usergroups_users.rb +9 -5
  134. data/lib/slack/web/api/endpoints/users.rb +20 -18
  135. data/lib/slack/web/api/endpoints/users_profile.rb +7 -7
  136. data/lib/slack/web/api/endpoints/views.rb +13 -13
  137. data/lib/slack/web/api/endpoints/workflows.rb +61 -0
  138. data/lib/slack/web/api/endpoints.rb +26 -20
  139. data/lib/slack/web/api/errors/server_error.rb +37 -0
  140. data/lib/slack/web/api/errors/too_many_requests_error.rb +1 -4
  141. data/lib/slack/web/api/errors.rb +394 -10
  142. data/lib/slack/web/api/mixins/conversations.id.rb +1 -3
  143. data/lib/slack/web/api/mixins/ids.id.rb +2 -2
  144. data/lib/slack/web/api/mixins/users.id.rb +1 -3
  145. data/lib/slack/web/api/mixins.rb +0 -2
  146. data/lib/slack/web/api/patches/chat.1.patch +6 -8
  147. data/lib/slack/web/api/templates/endpoints.erb +1 -2
  148. data/lib/slack/web/api/templates/method_spec.erb +1 -1
  149. data/lib/slack/web/config.rb +2 -0
  150. data/lib/slack/web/faraday/connection.rb +2 -2
  151. data/lib/slack/web/faraday/request.rb +2 -1
  152. data/lib/slack/web/faraday/response/raise_error.rb +12 -1
  153. data/lib/slack/web/faraday/response/wrap_error.rb +24 -0
  154. data/lib/slack/web/pagination/cursor.rb +1 -5
  155. data/lib/slack-ruby-client.rb +2 -0
  156. data/lib/tasks/web.rake +11 -3
  157. data/slack-ruby-client.gemspec +2 -3
  158. data/spec/fixtures/slack/web/429_error.yml +50 -54
  159. data/spec/fixtures/slack/web/auth_test_error.yml +51 -18
  160. data/spec/fixtures/slack/web/auth_test_success.yml +50 -26
  161. data/spec/fixtures/slack/web/conversations_info.yml +167 -0
  162. data/spec/fixtures/slack/web/conversations_setTopic.yml +84 -0
  163. data/spec/fixtures/slack/web/conversations_setTopic_one_page.yml +172 -0
  164. data/spec/fixtures/slack/web/conversations_setTopic_paginated.yml +253 -0
  165. data/spec/fixtures/slack/web/paginated_users_list.yml +501 -69
  166. data/spec/fixtures/slack/web/rtm_connect.yml +267 -30
  167. data/spec/fixtures/slack/web/rtm_start.yml +771 -60
  168. data/spec/fixtures/slack/web/users_info.yml +153 -69
  169. data/spec/fixtures/slack/web/users_list.yml +102 -41
  170. data/spec/fixtures/slack/web/views_open_error.yml +49 -42
  171. data/spec/slack/events/request_spec.rb +13 -8
  172. data/spec/slack/real_time/client_spec.rb +35 -22
  173. data/spec/slack/real_time/concurrency/with_concurrency_spec.rb +10 -0
  174. data/spec/slack/real_time/concurrency/without_concurrency_spec.rb +10 -0
  175. data/spec/slack/real_time/event_handlers/bot_spec.rb +1 -1
  176. data/spec/slack/real_time/event_handlers/channel_spec.rb +1 -1
  177. data/spec/slack/real_time/event_handlers/im_spec.rb +5 -5
  178. data/spec/slack/real_time/event_handlers/user_spec.rb +2 -2
  179. data/spec/slack/real_time/rtm_connect_spec.rb +1 -1
  180. data/spec/slack/real_time/rtm_start_spec.rb +1 -1
  181. data/spec/slack/slack_spec.rb +3 -1
  182. data/spec/slack/web/api/endpoints/admin_analytics_spec.rb +13 -0
  183. data/spec/slack/web/api/endpoints/admin_apps_spec.rb +10 -0
  184. data/spec/slack/web/api/endpoints/admin_auth_policy_spec.rb +35 -0
  185. data/spec/slack/web/api/endpoints/admin_barriers_spec.rb +38 -0
  186. data/spec/slack/web/api/endpoints/{apps_permissions_scopes_spec.rb → admin_conversations_ekm_spec.rb} +1 -1
  187. data/spec/slack/web/api/endpoints/admin_conversations_restrictAccess_spec.rb +5 -5
  188. data/spec/slack/web/api/endpoints/admin_conversations_spec.rb +85 -0
  189. data/spec/slack/web/api/endpoints/admin_emoji_spec.rb +6 -6
  190. data/spec/slack/web/api/endpoints/admin_teams_settings_spec.rb +10 -10
  191. data/spec/slack/web/api/endpoints/admin_teams_spec.rb +2 -2
  192. data/spec/slack/web/api/endpoints/admin_usergroups_spec.rb +6 -6
  193. data/spec/slack/web/api/endpoints/admin_users_session_spec.rb +28 -0
  194. data/spec/slack/web/api/endpoints/admin_users_spec.rb +15 -23
  195. data/spec/slack/web/api/endpoints/{apps_permissions_resources_spec.rb → apps_connections_spec.rb} +1 -1
  196. data/spec/slack/web/api/endpoints/apps_event_authorizations_spec.rb +13 -0
  197. data/spec/slack/web/api/endpoints/apps_manifest_spec.rb +36 -0
  198. data/spec/slack/web/api/endpoints/apps_spec.rb +2 -2
  199. data/spec/slack/web/api/endpoints/auth_teams_spec.rb +8 -0
  200. data/spec/slack/web/api/endpoints/calls_participants_spec.rb +4 -4
  201. data/spec/slack/web/api/endpoints/calls_spec.rb +2 -2
  202. data/spec/slack/web/api/endpoints/custom_specs/auth_spec.rb +4 -6
  203. data/spec/slack/web/api/endpoints/custom_specs/conversations_spec.rb +13 -0
  204. data/spec/slack/web/api/endpoints/custom_specs/users_spec.rb +2 -2
  205. data/spec/slack/web/api/endpoints/dnd_spec.rb +0 -5
  206. data/spec/slack/web/api/endpoints/files_comments_spec.rb +2 -2
  207. data/spec/slack/web/api/endpoints/files_remote_spec.rb +3 -3
  208. data/spec/slack/web/api/endpoints/files_spec.rb +4 -4
  209. data/spec/slack/web/api/endpoints/oauth_spec.rb +0 -11
  210. data/spec/slack/web/api/endpoints/oauth_v2_spec.rb +6 -3
  211. data/spec/slack/web/api/endpoints/openid_connect_spec.rb +8 -0
  212. data/spec/slack/web/api/endpoints/pins_spec.rb +1 -4
  213. data/spec/slack/web/api/endpoints/reactions_spec.rb +3 -3
  214. data/spec/slack/web/api/endpoints/reminders_spec.rb +2 -2
  215. data/spec/slack/web/api/endpoints/team_billing_spec.rb +8 -0
  216. data/spec/slack/web/api/endpoints/team_preferences_spec.rb +8 -0
  217. data/spec/slack/web/api/endpoints/tooling_tokens_spec.rb +13 -0
  218. data/spec/slack/web/api/endpoints/usergroups_users_spec.rb +2 -2
  219. data/spec/slack/web/api/endpoints/workflows_spec.rb +26 -0
  220. data/spec/slack/web/api/error_spec.rb +5 -7
  221. data/spec/slack/web/api/errors/slack_error_spec.rb +21 -26
  222. data/spec/slack/web/api/mixins/conversations_list_spec.rb +21 -0
  223. data/spec/slack/web/api/mixins/conversations_spec.rb +11 -9
  224. data/spec/slack/web/api/mixins/users_spec.rb +1 -1
  225. data/spec/slack/web/api/pagination/cursor_spec.rb +1 -3
  226. data/spec/slack/web/client_spec.rb +112 -16
  227. data/spec/slack/web/faraday/request_spec.rb +80 -0
  228. data/spec/slack/web/faraday/response/raise_error_spec.rb +8 -6
  229. data/spec/spec_helper.rb +1 -1
  230. data/spec/support/real_time/connected_client.rb +1 -7
  231. data/spec/support/vcr.rb +36 -1
  232. metadata +58 -155
  233. data/examples/hi_real_time/Gemfile +0 -6
  234. data/examples/hi_real_time/hi.gif +0 -0
  235. data/examples/hi_real_time/hi.rb +0 -41
  236. data/examples/hi_real_time_async_celluloid/Gemfile +0 -7
  237. data/examples/hi_real_time_async_celluloid/Procfile +0 -2
  238. data/examples/hi_real_time_async_celluloid/hi.rb +0 -39
  239. data/examples/hi_real_time_async_eventmachine/Gemfile +0 -7
  240. data/examples/hi_real_time_async_eventmachine/Procfile +0 -2
  241. data/examples/hi_real_time_async_eventmachine/hi.rb +0 -39
  242. data/lib/slack/real_time/concurrency/celluloid.rb +0 -142
  243. data/lib/slack/real_time/concurrency/eventmachine.rb +0 -85
  244. data/lib/slack/web/api/mixins/channels.id.json +0 -20
  245. data/lib/slack/web/api/mixins/channels.id.rb +0 -27
  246. data/lib/slack/web/api/mixins/groups.id.json +0 -20
  247. data/lib/slack/web/api/mixins/groups.id.rb +0 -27
  248. data/spec/fixtures/slack/web/503_error.yml +0 -14
  249. data/spec/fixtures/slack/web/channels_info.yml +0 -139
  250. data/spec/fixtures/slack/web/groups_info.yml +0 -43
  251. data/spec/slack/real_time/concurrency/celluloid_spec.rb +0 -116
  252. data/spec/slack/real_time/concurrency/eventmachine_spec.rb +0 -57
  253. data/spec/slack/web/api/endpoints/admin_conversations_whitelist_spec.rb +0 -32
  254. data/spec/slack/web/api/endpoints/apps_permissions_spec.rb +0 -16
  255. data/spec/slack/web/api/endpoints/apps_permissions_users_spec.rb +0 -19
  256. data/spec/slack/web/api/endpoints/conversations_spec.rb +0 -101
  257. data/spec/slack/web/api/endpoints/custom_specs/channels_spec.rb +0 -13
  258. data/spec/slack/web/api/endpoints/custom_specs/groups_spec.rb +0 -13
  259. data/spec/slack/web/api/endpoints/im_spec.rb +0 -39
  260. data/spec/slack/web/api/endpoints/mpim_spec.rb +0 -39
  261. data/spec/slack/web/api/endpoints/views_spec.rb +0 -29
  262. data/spec/slack/web/api/errors/service_unavailable_spec.rb +0 -17
  263. data/spec/slack/web/api/mixins/channels_spec.rb +0 -43
  264. data/spec/slack/web/api/mixins/groups_spec.rb +0 -43
@@ -7,13 +7,231 @@ module Slack
7
7
  module Endpoints
8
8
  module AdminConversations
9
9
  #
10
- # Set the workspaces in an Enterprise grid org that connect to a channel.
10
+ # Archive a public or private channel.
11
11
  #
12
12
  # @option options [Object] :channel_id
13
+ # The channel to archive.
14
+ # @see https://api.slack.com/methods/admin.conversations.archive
15
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.archive.json
16
+ def admin_conversations_archive(options = {})
17
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
18
+ post('admin.conversations.archive', options)
19
+ end
20
+
21
+ #
22
+ # Convert a public channel to a private channel.
23
+ #
24
+ # @option options [Object] :channel_id
25
+ # The channel to convert to private.
26
+ # @see https://api.slack.com/methods/admin.conversations.convertToPrivate
27
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.convertToPrivate.json
28
+ def admin_conversations_convertToPrivate(options = {})
29
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
30
+ post('admin.conversations.convertToPrivate', options)
31
+ end
32
+
33
+ #
34
+ # Create a public or private channel-based conversation.
35
+ #
36
+ # @option options [boolean] :is_private
37
+ # When true, creates a private channel instead of a public channel.
38
+ # @option options [string] :name
39
+ # Name of the public or private channel to create.
40
+ # @option options [string] :description
41
+ # Description of the public or private channel to create.
42
+ # @option options [boolean] :org_wide
43
+ # 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.
44
+ # @option options [Object] :team_id
45
+ # The workspace to create the channel in. Note: this argument is required unless you set org_wide=true.
46
+ # @see https://api.slack.com/methods/admin.conversations.create
47
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.create.json
48
+ def admin_conversations_create(options = {})
49
+ throw ArgumentError.new('Required arguments :is_private missing') if options[:is_private].nil?
50
+ throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
51
+ post('admin.conversations.create', options)
52
+ end
53
+
54
+ #
55
+ # Delete a public or private channel.
56
+ #
57
+ # @option options [Object] :channel_id
58
+ # The channel to delete.
59
+ # @see https://api.slack.com/methods/admin.conversations.delete
60
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.delete.json
61
+ def admin_conversations_delete(options = {})
62
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
63
+ post('admin.conversations.delete', options)
64
+ end
65
+
66
+ #
67
+ # Disconnect a connected channel from one or more workspaces.
68
+ #
69
+ # @option options [Object] :channel_id
70
+ # The channel to be disconnected from some workspaces.
71
+ # @option options [array] :leaving_team_ids
72
+ # team IDs getting removed from the channel, optional if there are only two teams in the channel.
73
+ # @see https://api.slack.com/methods/admin.conversations.disconnectShared
74
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.disconnectShared.json
75
+ def admin_conversations_disconnectShared(options = {})
76
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
77
+ post('admin.conversations.disconnectShared', options)
78
+ end
79
+
80
+ #
81
+ # Get conversation preferences for a public or private channel.
82
+ #
83
+ # @option options [Object] :channel_id
84
+ # The channel to get preferences for.
85
+ # @see https://api.slack.com/methods/admin.conversations.getConversationPrefs
86
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.getConversationPrefs.json
87
+ def admin_conversations_getConversationPrefs(options = {})
88
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
89
+ post('admin.conversations.getConversationPrefs', options)
90
+ end
91
+
92
+ #
93
+ # This API endpoint can be used by any admin to get a channel's retention policy.
94
+ #
95
+ # @option options [string] :channel_id
96
+ # The channel to get the retention policy for.
97
+ # @see https://api.slack.com/methods/admin.conversations.getCustomRetention
98
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.getCustomRetention.json
99
+ def admin_conversations_getCustomRetention(options = {})
100
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
101
+ post('admin.conversations.getCustomRetention', options)
102
+ end
103
+
104
+ #
105
+ # Get all the workspaces a given public or private channel is connected to within this Enterprise org.
106
+ #
107
+ # @option options [Object] :channel_id
108
+ # The channel to determine connected workspaces within the organization for.
109
+ # @option options [string] :cursor
110
+ # Set cursor to next_cursor returned by the previous call to list items in the next page.
111
+ # @option options [integer] :limit
112
+ # The maximum number of items to return. Must be between 1 - 1000 both inclusive.
113
+ # @see https://api.slack.com/methods/admin.conversations.getTeams
114
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.getTeams.json
115
+ def admin_conversations_getTeams(options = {})
116
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
117
+ if block_given?
118
+ Pagination::Cursor.new(self, :admin_conversations_getTeams, options).each do |page|
119
+ yield page
120
+ end
121
+ else
122
+ post('admin.conversations.getTeams', options)
123
+ end
124
+ end
125
+
126
+ #
127
+ # Invite a user to a public or private channel.
128
+ #
129
+ # @option options [Object] :channel_id
130
+ # The channel that the users will be invited to.
131
+ # @option options [array] :user_ids
132
+ # The users to invite.
133
+ # @see https://api.slack.com/methods/admin.conversations.invite
134
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.invite.json
135
+ def admin_conversations_invite(options = {})
136
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
137
+ throw ArgumentError.new('Required arguments :user_ids missing') if options[:user_ids].nil?
138
+ post('admin.conversations.invite', options)
139
+ end
140
+
141
+ #
142
+ # This API endpoint can be used by any admin to remove a channel's retention policy.
143
+ #
144
+ # @option options [string] :channel_id
145
+ # The channel to set the retention policy for.
146
+ # @see https://api.slack.com/methods/admin.conversations.removeCustomRetention
147
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.removeCustomRetention.json
148
+ def admin_conversations_removeCustomRetention(options = {})
149
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
150
+ post('admin.conversations.removeCustomRetention', options)
151
+ end
152
+
153
+ #
154
+ # Rename a public or private channel.
155
+ #
156
+ # @option options [Object] :channel_id
157
+ # The channel to rename.
158
+ # @option options [string] :name
159
+ # .
160
+ # @see https://api.slack.com/methods/admin.conversations.rename
161
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.rename.json
162
+ def admin_conversations_rename(options = {})
163
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
164
+ throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
165
+ post('admin.conversations.rename', options)
166
+ end
167
+
168
+ #
169
+ # Search for public or private channels in an Enterprise organization.
170
+ #
171
+ # @option options [string] :cursor
172
+ # Set cursor to next_cursor returned by the previous call to list items in the next page.
173
+ # @option options [integer] :limit
174
+ # Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.
175
+ # @option options [string] :query
176
+ # Name of the the channel to query by.
177
+ # @option options [array] :search_channel_types
178
+ # 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.
179
+ # @option options [string] :sort
180
+ # 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.
181
+ # @option options [string] :sort_dir
182
+ # 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).
183
+ # @option options [array] :team_ids
184
+ # Comma separated string of team IDs, signifying the workspaces to search through.
185
+ # @see https://api.slack.com/methods/admin.conversations.search
186
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.search.json
187
+ def admin_conversations_search(options = {})
188
+ if block_given?
189
+ Pagination::Cursor.new(self, :admin_conversations_search, options).each do |page|
190
+ yield page
191
+ end
192
+ else
193
+ post('admin.conversations.search', options)
194
+ end
195
+ end
196
+
197
+ #
198
+ # Set the posting permissions for a public or private channel.
199
+ #
200
+ # @option options [string] :channel_id
201
+ # The channel to set the prefs for.
202
+ # @option options [string] :prefs
203
+ # The prefs for this channel in a stringified JSON format.
204
+ # @see https://api.slack.com/methods/admin.conversations.setConversationPrefs
205
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.setConversationPrefs.json
206
+ def admin_conversations_setConversationPrefs(options = {})
207
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
208
+ throw ArgumentError.new('Required arguments :prefs missing') if options[:prefs].nil?
209
+ post('admin.conversations.setConversationPrefs', options)
210
+ end
211
+
212
+ #
213
+ # This API endpoint can be used by any admin to set a channel's retention policy.
214
+ #
215
+ # @option options [string] :channel_id
216
+ # The channel to set the retention policy for.
217
+ # @option options [integer] :duration_days
218
+ # The message retention duration in days to set for this channel.
219
+ # @see https://api.slack.com/methods/admin.conversations.setCustomRetention
220
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.setCustomRetention.json
221
+ def admin_conversations_setCustomRetention(options = {})
222
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
223
+ throw ArgumentError.new('Required arguments :duration_days missing') if options[:duration_days].nil?
224
+ post('admin.conversations.setCustomRetention', options)
225
+ end
226
+
227
+ #
228
+ # Set the workspaces in an Enterprise grid org that connect to a public or private channel.
229
+ #
230
+ # @option options [string] :channel_id
13
231
  # The encoded channel_id to add or remove to workspaces.
14
- # @option options [Object] :org_channel
232
+ # @option options [boolean] :org_channel
15
233
  # True if channel has to be converted to an org channel.
16
- # @option options [Object] :target_team_ids
234
+ # @option options [array] :target_team_ids
17
235
  # A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.
18
236
  # @option options [Object] :team_id
19
237
  # The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.
@@ -23,6 +241,18 @@ module Slack
23
241
  throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
24
242
  post('admin.conversations.setTeams', options)
25
243
  end
244
+
245
+ #
246
+ # Unarchive a public or private channel.
247
+ #
248
+ # @option options [Object] :channel_id
249
+ # The channel to unarchive.
250
+ # @see https://api.slack.com/methods/admin.conversations.unarchive
251
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.unarchive.json
252
+ def admin_conversations_unarchive(options = {})
253
+ throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
254
+ post('admin.conversations.unarchive', options)
255
+ end
26
256
  end
27
257
  end
28
258
  end
@@ -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
@@ -14,7 +14,7 @@ module Slack
14
14
  # @option options [Object] :group_id
15
15
  # The IDP Group ID to be an allowlist for the private channel.
16
16
  # @option options [Object] :team_id
17
- # The workspace where the IDP Group and channel exist.
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
18
  # @see https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup
19
19
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.restrictAccess/admin.conversations.restrictAccess.addGroup.json
20
20
  def admin_conversations_restrictAccess_addGroup(options = {})
@@ -29,7 +29,7 @@ module Slack
29
29
  # @option options [Object] :channel_id
30
30
  # .
31
31
  # @option options [Object] :team_id
32
- # 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.
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
33
  # @see https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups
34
34
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.restrictAccess/admin.conversations.restrictAccess.listGroups.json
35
35
  def admin_conversations_restrictAccess_listGroups(options = {})
@@ -45,7 +45,7 @@ module Slack
45
45
  # @option options [Object] :group_id
46
46
  # The IDP Group ID to remove from the private channel.
47
47
  # @option options [Object] :team_id
48
- # The workspace where the IDP Group and channel exist.
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
49
  # @see https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup
50
50
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.restrictAccess/admin.conversations.restrictAccess.removeGroup.json
51
51
  def admin_conversations_restrictAccess_removeGroup(options = {})
@@ -20,7 +20,7 @@ module Slack
20
20
  def admin_conversations_whitelist_add(options = {})
21
21
  throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
22
22
  throw ArgumentError.new('Required arguments :group_id missing') if options[:group_id].nil?
23
- logger.warn('admin.conversations.whitelist.add: Alternative methods: .')
23
+ logger.warn('admin.conversations.whitelist.add: This method is deprecated Alternative methods: .')
24
24
  post('admin.conversations.whitelist.add', options)
25
25
  end
26
26
 
@@ -35,7 +35,7 @@ module Slack
35
35
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations.whitelist/admin.conversations.whitelist.listGroupsLinkedToChannel.json
36
36
  def admin_conversations_whitelist_listGroupsLinkedToChannel(options = {})
37
37
  throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
38
- logger.warn('admin.conversations.whitelist.listGroupsLinkedToChannel: Alternative methods: .')
38
+ logger.warn('admin.conversations.whitelist.listGroupsLinkedToChannel: This method is deprecated Alternative methods: .')
39
39
  post('admin.conversations.whitelist.listGroupsLinkedToChannel', options)
40
40
  end
41
41
 
@@ -54,7 +54,7 @@ module Slack
54
54
  throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
55
55
  throw ArgumentError.new('Required arguments :group_id missing') if options[:group_id].nil?
56
56
  throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
57
- logger.warn('admin.conversations.whitelist.remove: Alternative methods: .')
57
+ logger.warn('admin.conversations.whitelist.remove: This method is deprecated Alternative methods: .')
58
58
  post('admin.conversations.whitelist.remove', options)
59
59
  end
60
60
  end
@@ -9,9 +9,9 @@ module Slack
9
9
  #
10
10
  # Add an emoji.
11
11
  #
12
- # @option options [Object] :name
13
- # The name of the emoji to be removed. Colons (:myemoji:) around the value are not required, although they may be included.
14
- # @option options [Object] :url
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 [Object] :alias_for
27
+ # @option options [string] :alias_for
28
28
  # The alias of the emoji.
29
- # @option options [Object] :name
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 [Object] :cursor
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 [Object] :limit
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 [Object] :name
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 [Object] :name
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 [Object] :new_name
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 [Object] :invite_request_id
12
+ # @option options [string] :invite_request_id
13
13
  # ID of the request to invite.
14
- # @option options [Object] :team_id
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 [Object] :invite_request_id
26
+ # @option options [string] :invite_request_id
27
27
  # ID of the request to invite.
28
- # @option options [Object] :team_id
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 [Object] :cursor
40
+ # @option options [string] :cursor
41
41
  # Value of the next_cursor field sent as part of the previous API response.
42
- # @option options [Object] :limit
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 [Object] :team_id
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 [Object] :cursor
12
+ # @option options [string] :cursor
13
13
  # Value of the next_cursor field sent as part of the previous API response.
14
- # @option options [Object] :limit
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 [Object] :team_id
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 [Object] :cursor
12
+ # @option options [string] :cursor
13
13
  # Value of the next_cursor field sent as part of the previous api response.
14
- # @option options [Object] :limit
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 [Object] :team_domain
13
- # Team domain (for example, slacksoftballteam).
14
- # @option options [Object] :team_name
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 [Object] :team_description
16
+ # @option options [string] :team_description
17
17
  # Description for the team.
18
- # @option options [Object] :team_discoverability
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 [Object] :cursor
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 [Object] :limit
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 [Object] :cursor
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 [Object] :limit
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 [Object] :cursor
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 [Object] :limit
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 [Object] :channel_ids
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 [Object] :description
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 [Object] :discoverability
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 [Object] :image_url
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 [Object] :name
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.
@@ -7,13 +7,13 @@ module Slack
7
7
  module Endpoints
8
8
  module AdminUsergroups
9
9
  #
10
- # Add one or more default channels to an IDP group.
10
+ # Add up to one hundred default channels to an IDP group.
11
11
  #
12
- # @option options [Object] :channel_ids
12
+ # @option options [array] :channel_ids
13
13
  # Comma separated string of channel IDs.
14
- # @option options [Object] :usergroup_id
14
+ # @option options [string] :usergroup_id
15
15
  # ID of the IDP group to add default channels for.
16
- # @option options [Object] :team_id
16
+ # @option options [string] :team_id
17
17
  # The workspace to add default channels in.
18
18
  # @see https://api.slack.com/methods/admin.usergroups.addChannels
19
19
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.addChannels.json
@@ -26,11 +26,11 @@ module Slack
26
26
  #
27
27
  # Associate one or more default workspaces with an organization-wide IDP group.
28
28
  #
29
- # @option options [Object] :team_ids
29
+ # @option options [array] :team_ids
30
30
  # A comma separated list of encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token.
31
- # @option options [Object] :usergroup_id
31
+ # @option options [string] :usergroup_id
32
32
  # An encoded usergroup (IDP Group) ID.
33
- # @option options [Object] :auto_provision
33
+ # @option options [boolean] :auto_provision
34
34
  # When true, this method automatically creates new workspace accounts for the IDP group members.
35
35
  # @see https://api.slack.com/methods/admin.usergroups.addTeams
36
36
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.addTeams.json
@@ -45,9 +45,9 @@ module Slack
45
45
  #
46
46
  # @option options [Object] :usergroup_id
47
47
  # ID of the IDP group to list default channels for.
48
- # @option options [Object] :include_num_members
48
+ # @option options [boolean] :include_num_members
49
49
  # Flag to include or exclude the count of members per channel.
50
- # @option options [Object] :team_id
50
+ # @option options [string] :team_id
51
51
  # ID of the the workspace.
52
52
  # @see https://api.slack.com/methods/admin.usergroups.listChannels
53
53
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.listChannels.json
@@ -59,9 +59,9 @@ module Slack
59
59
  #
60
60
  # Remove one or more default channels from an org-level IDP group (user group).
61
61
  #
62
- # @option options [Object] :channel_ids
62
+ # @option options [array] :channel_ids
63
63
  # Comma-separated string of channel IDs.
64
- # @option options [Object] :usergroup_id
64
+ # @option options [string] :usergroup_id
65
65
  # ID of the IDP Group.
66
66
  # @see https://api.slack.com/methods/admin.usergroups.removeChannels
67
67
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.removeChannels.json