slack-ruby-client 0.13.0 → 0.17.0

data/lib/slack/web/api/endpoints/admin_teams_owners.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminTeamsOwners
+          #
+          # List all of the owners on a given workspace.
+          #
+          # @option options [Object] :team_id
+          #   .
+          # @option options [Object] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @see https://api.slack.com/methods/admin.teams.owners.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.owners/admin.teams.owners.list.json
+          def admin_teams_owners_list(options = {})
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            if block_given?
+              Pagination::Cursor.new(self, :admin_teams_owners_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.teams.owners.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/admin_teams_settings.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminTeamsSettings
+          #
+          # Fetch information about settings in a workspace
+          #
+          # @option options [Object] :team_id
+          #   .
+          # @see https://api.slack.com/methods/admin.teams.settings.info
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.settings/admin.teams.settings.info.json
+          def admin_teams_settings_info(options = {})
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            post('admin.teams.settings.info', options)
+          end
+
+          #
+          # Set the default channels of a workspace.
+          #
+          # @option options [Object] :channel_ids
+          #   An array of channel IDs.
+          # @option options [Object] :team_id
+          #   ID for the workspace to set the default channel for.
+          # @see https://api.slack.com/methods/admin.teams.settings.setDefaultChannels
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.settings/admin.teams.settings.setDefaultChannels.json
+          def admin_teams_settings_setDefaultChannels(options = {})
+            throw ArgumentError.new('Required arguments :channel_ids missing') if options[:channel_ids].nil?
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            post('admin.teams.settings.setDefaultChannels', options)
+          end
+
+          #
+          # Set the description of a given workspace.
+          #
+          # @option options [Object] :description
+          #   The new description for the workspace.
+          # @option options [Object] :team_id
+          #   ID for the workspace to set the description for.
+          # @see https://api.slack.com/methods/admin.teams.settings.setDescription
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.settings/admin.teams.settings.setDescription.json
+          def admin_teams_settings_setDescription(options = {})
+            throw ArgumentError.new('Required arguments :description missing') if options[:description].nil?
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            post('admin.teams.settings.setDescription', options)
+          end
+
+          #
+          # An API method that allows admins to set the discoverability of a given workspace
+          #
+          # @option options [Object] :discoverability
+          #   This workspace's discovery setting. It must be set to one of open, invite_only, closed, or unlisted.
+          # @option options [Object] :team_id
+          #   The ID of the workspace to set discoverability on.
+          # @see https://api.slack.com/methods/admin.teams.settings.setDiscoverability
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.settings/admin.teams.settings.setDiscoverability.json
+          def admin_teams_settings_setDiscoverability(options = {})
+            throw ArgumentError.new('Required arguments :discoverability missing') if options[:discoverability].nil?
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            post('admin.teams.settings.setDiscoverability', options)
+          end
+
+          #
+          # Sets the icon of a workspace.
+          #
+          # @option options [Object] :image_url
+          #   Image URL for the icon.
+          # @option options [Object] :team_id
+          #   ID for the workspace to set the icon for.
+          # @see https://api.slack.com/methods/admin.teams.settings.setIcon
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.settings/admin.teams.settings.setIcon.json
+          def admin_teams_settings_setIcon(options = {})
+            throw ArgumentError.new('Required arguments :image_url missing') if options[:image_url].nil?
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            post('admin.teams.settings.setIcon', options)
+          end
+
+          #
+          # Set the name of a given workspace.
+          #
+          # @option options [Object] :name
+          #   The new name of the workspace.
+          # @option options [Object] :team_id
+          #   ID for the workspace to set the name for.
+          # @see https://api.slack.com/methods/admin.teams.settings.setName
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.teams.settings/admin.teams.settings.setName.json
+          def admin_teams_settings_setName(options = {})
+            throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            post('admin.teams.settings.setName', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/admin_usergroups.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminUsergroups
+          #
+          # Add up to one hundred default channels to an IDP group.
+          #
+          # @option options [Object] :channel_ids
+          #   Comma separated string of channel IDs.
+          # @option options [Object] :usergroup_id
+          #   ID of the IDP group to add default channels for.
+          # @option options [Object] :team_id
+          #   The workspace to add default channels in.
+          # @see https://api.slack.com/methods/admin.usergroups.addChannels
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.addChannels.json
+          def admin_usergroups_addChannels(options = {})
+            throw ArgumentError.new('Required arguments :channel_ids missing') if options[:channel_ids].nil?
+            throw ArgumentError.new('Required arguments :usergroup_id missing') if options[:usergroup_id].nil?
+            post('admin.usergroups.addChannels', options)
+          end
+
+          #
+          # Associate one or more default workspaces with an organization-wide IDP group.
+          #
+          # @option options [Object] :team_ids
+          #   A comma separated list of encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token.
+          # @option options [Object] :usergroup_id
+          #   An encoded usergroup (IDP Group) ID.
+          # @option options [Object] :auto_provision
+          #   When true, this method automatically creates new workspace accounts for the IDP group members.
+          # @see https://api.slack.com/methods/admin.usergroups.addTeams
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.addTeams.json
+          def admin_usergroups_addTeams(options = {})
+            throw ArgumentError.new('Required arguments :team_ids missing') if options[:team_ids].nil?
+            throw ArgumentError.new('Required arguments :usergroup_id missing') if options[:usergroup_id].nil?
+            post('admin.usergroups.addTeams', options)
+          end
+
+          #
+          # List the channels linked to an org-level IDP group (user group).
+          #
+          # @option options [Object] :usergroup_id
+          #   ID of the IDP group to list default channels for.
+          # @option options [Object] :include_num_members
+          #   Flag to include or exclude the count of members per channel.
+          # @option options [Object] :team_id
+          #   ID of the the workspace.
+          # @see https://api.slack.com/methods/admin.usergroups.listChannels
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.listChannels.json
+          def admin_usergroups_listChannels(options = {})
+            throw ArgumentError.new('Required arguments :usergroup_id missing') if options[:usergroup_id].nil?
+            post('admin.usergroups.listChannels', options)
+          end
+
+          #
+          # Remove one or more default channels from an org-level IDP group (user group).
+          #
+          # @option options [Object] :channel_ids
+          #   Comma-separated string of channel IDs.
+          # @option options [Object] :usergroup_id
+          #   ID of the IDP Group.
+          # @see https://api.slack.com/methods/admin.usergroups.removeChannels
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.removeChannels.json
+          def admin_usergroups_removeChannels(options = {})
+            throw ArgumentError.new('Required arguments :channel_ids missing') if options[:channel_ids].nil?
+            throw ArgumentError.new('Required arguments :usergroup_id missing') if options[:usergroup_id].nil?
+            post('admin.usergroups.removeChannels', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/admin_users.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminUsers
+          #
+          # Add an Enterprise user to a workspace.
+          #
+          # @option options [Object] :team_id
+          #   The ID (T1234) of the workspace.
+          # @option options [Object] :user_id
+          #   The ID of the user to add to the workspace.
+          # @option options [Object] :channel_ids
+          #   Comma separated values of channel IDs to add user in the new workspace.
+          # @option options [Object] :is_restricted
+          #   True if user should be added to the workspace as a guest.
+          # @option options [Object] :is_ultra_restricted
+          #   True if user should be added to the workspace as a single-channel guest.
+          # @see https://api.slack.com/methods/admin.users.assign
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.assign.json
+          def admin_users_assign(options = {})
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
+            post('admin.users.assign', options)
+          end
+
+          #
+          # Invite a user to a workspace.
+          #
+          # @option options [Object] :channel_ids
+          #   A comma-separated list of channel_ids for this user to join. At least one channel is required.
+          # @option options [Object] :email
+          #   The email address of the person to invite.
+          # @option options [Object] :team_id
+          #   The ID (T1234) of the workspace.
+          # @option options [Object] :custom_message
+          #   An optional message to send to the user in the invite email.
+          # @option options [Object] :guest_expiration_ts
+          #   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.
+          # @option options [Object] :is_restricted
+          #   Is this user a multi-channel guest user? (default: false).
+          # @option options [Object] :is_ultra_restricted
+          #   Is this user a single channel guest user? (default: false).
+          # @option options [Object] :real_name
+          #   Full name of the user.
+          # @option options [Object] :resend
+          #   Allow this invite to be resent in the future if a user has not signed up yet. (default: false).
+          # @see https://api.slack.com/methods/admin.users.invite
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.invite.json
+          def admin_users_invite(options = {})
+            throw ArgumentError.new('Required arguments :channel_ids missing') if options[:channel_ids].nil?
+            throw ArgumentError.new('Required arguments :email missing') if options[:email].nil?
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            post('admin.users.invite', options)
+          end
+
+          #
+          # List users on a workspace
+          #
+          # @option options [Object] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :limit
+          #   Limit for how many users to be retrieved per page.
+          # @option options [Object] :team_id
+          #   The ID (T1234) of the workspace.
+          # @see https://api.slack.com/methods/admin.users.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.list.json
+          def admin_users_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_users_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.users.list', options)
+            end
+          end
+
+          #
+          # Remove a user from a workspace.
+          #
+          # @option options [Object] :team_id
+          #   The ID (T1234) of the workspace.
+          # @option options [Object] :user_id
+          #   The ID of the user to remove.
+          # @see https://api.slack.com/methods/admin.users.remove
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.remove.json
+          def admin_users_remove(options = {})
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
+            post('admin.users.remove', options)
+          end
+
+          #
+          # Set an existing guest, regular user, or owner to be an admin user.
+          #
+          # @option options [Object] :team_id
+          #   The ID (T1234) of the workspace.
+          # @option options [Object] :user_id
+          #   The ID of the user to designate as an admin.
+          # @see https://api.slack.com/methods/admin.users.setAdmin
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setAdmin.json
+          def admin_users_setAdmin(options = {})
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
+            post('admin.users.setAdmin', options)
+          end
+
+          #
+          # Set an expiration for a guest user
+          #
+          # @option options [Object] :expiration_ts
+          #   Timestamp when guest account should be disabled.
+          # @option options [Object] :user_id
+          #   The ID of the user to set an expiration for.
+          # @option options [Object] :team_id
+          #   The ID (T1234) of the workspace.
+          # @see https://api.slack.com/methods/admin.users.setExpiration
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setExpiration.json
+          def admin_users_setExpiration(options = {})
+            throw ArgumentError.new('Required arguments :expiration_ts missing') if options[:expiration_ts].nil?
+            throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
+            post('admin.users.setExpiration', options)
+          end
+
+          #
+          # Set an existing guest, regular user, or admin user to be a workspace owner.
+          #
+          # @option options [Object] :team_id
+          #   The ID (T1234) of the workspace.
+          # @option options [Object] :user_id
+          #   Id of the user to promote to owner.
+          # @see https://api.slack.com/methods/admin.users.setOwner
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setOwner.json
+          def admin_users_setOwner(options = {})
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
+            post('admin.users.setOwner', options)
+          end
+
+          #
+          # Set an existing guest user, admin user, or owner to be a regular user.
+          #
+          # @option options [Object] :team_id
+          #   The ID (T1234) of the workspace.
+          # @option options [Object] :user_id
+          #   The ID of the user to designate as a regular user.
+          # @see https://api.slack.com/methods/admin.users.setRegular
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setRegular.json
+          def admin_users_setRegular(options = {})
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
+            post('admin.users.setRegular', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/admin_users_session.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminUsersSession
+          #
+          # Revoke a single session for a user. The user will be forced to login to Slack.
+          #
+          # @option options [Object] :session_id
+          #   ID of the session to invalidate.
+          # @option options [Object] :team_id
+          #   ID of the workspace that the session belongs to.
+          # @see https://api.slack.com/methods/admin.users.session.invalidate
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.session/admin.users.session.invalidate.json
+          def admin_users_session_invalidate(options = {})
+            throw ArgumentError.new('Required arguments :session_id missing') if options[:session_id].nil?
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            post('admin.users.session.invalidate', options)
+          end
+
+          #
+          # List active user sessions for an organization
+          #
+          # @option options [Object] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [Object] :team_id
+          #   The ID of the workspace you'd like active sessions for. If you pass a team_id, you'll need to pass a user_id as well.
+          # @option options [Object] :user_id
+          #   The ID of user you'd like active sessions for. If you pass a user_id, you'll need to pass a team_id as well.
+          # @see https://api.slack.com/methods/admin.users.session.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.session/admin.users.session.list.json
+          def admin_users_session_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_users_session_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.users.session.list', options)
+            end
+          end
+
+          #
+          # Wipes all valid sessions on all devices for a given user
+          #
+          # @option options [Object] :user_id
+          #   The ID of the user to wipe sessions for.
+          # @option options [Object] :mobile_only
+          #   Only expire mobile sessions (default: false).
+          # @option options [Object] :web_only
+          #   Only expire web sessions (default: false).
+          # @see https://api.slack.com/methods/admin.users.session.reset
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.session/admin.users.session.reset.json
+          def admin_users_session_reset(options = {})
+            throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
+            post('admin.users.session.reset', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -10,8 +11,6 @@ module Slack
           #
           # @option options [Object] :error
           #   Error response to return.
-          # @option options [Object] :foo
-          #   example property to return.
           # @see https://api.slack.com/methods/api.test
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/api/api.test.json
           def api_test(options = {})