slack-ruby-client 0.14.2 → 0.15.0

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Rtm
           #
-          # This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.
+          # Starts a Real Time Messaging session.
           #
           # @option options [Object] :batch_presence_aware
           #   Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.
@@ -19,7 +20,7 @@ module Slack
           end
 
           #
-          # This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.
+          # Starts a Real Time Messaging session.
           #
           # @option options [Object] :batch_presence_aware
           #   Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Search
           #
-          # This method allows users and applications to search both messages and files in a single call.
+          # Searches for messages and files matching a query.
           #
           # @option options [Object] :query
           #   Search query. May contains booleans, etc.
@@ -24,7 +25,7 @@ module Slack
           end
 
           #
-          # This method returns files matching a search query.
+          # Searches for files matching a query.
           #
           # @option options [Object] :query
           #   Search query.
@@ -42,7 +43,7 @@ module Slack
           end
 
           #
-          # This method returns messages matching a search query.
+          # Searches for messages matching a query.
           #
           # @option options [Object] :query
           #   Search query.

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,8 +7,7 @@ module Slack
       module Endpoints
         module Stars
           #
-          # This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.
-          # One of file, file_comment, channel, or the combination of channel and timestamp must be specified.
+          # Adds a star to an item.
           #
           # @option options [channel] :channel
           #   Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
@@ -20,12 +20,12 @@ module Slack
           # @see https://api.slack.com/methods/stars.add
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/stars.add.json
           def stars_add(options = {})
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('stars.add', options)
           end
 
           #
-          # This method lists the items starred by the authed user.
+          # Lists stars for a user.
           #
           # @option options [Object] :cursor
           #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
@@ -44,8 +44,7 @@ module Slack
           end
 
           #
-          # This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.
-          # One of file, file_comment, channel, or the combination of channel and timestamp must be specified.
+          # Removes a star from an item.
           #
           # @option options [channel] :channel
           #   Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).
@@ -58,7 +57,7 @@ module Slack
           # @see https://api.slack.com/methods/stars.remove
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/stars.remove.json
           def stars_remove(options = {})
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('stars.remove', options)
           end
         end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Team
           #
-          # This method is used to retrieve the "access logs" for users on a workspace.
+          # Gets the access logs for the current team.
           #
           # @option options [Object] :before
           #   End of time range of logs to include in results (inclusive).
@@ -17,8 +18,7 @@ module Slack
           end
 
           #
-          # This method lists billable information for each user on the team. Currently this consists solely of whether the user is
-          # subject to billing per Slack's Fair Billing policy.
+          # Gets billable users information for the current team.
           #
           # @option options [user] :user
           #   A user to retrieve the billable information for. Defaults to all users.
@@ -30,8 +30,10 @@ module Slack
           end
 
           #
-          # This method provides information about your team.
+          # Gets information about the current team.
           #
+          # @option options [Object] :team
+          #   Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels.
           # @see https://api.slack.com/methods/team.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/team/team.info.json
           def team_info(options = {})
@@ -39,7 +41,7 @@ module Slack
           end
 
           #
-          # This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins.
+          # Gets the integration logs for the current team.
           #
           # @option options [Object] :app_id
           #   Filter logs to this Slack app. Defaults to all logs.

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module TeamProfile
           #
-          # This method is used to get the profile field definitions for this team.
+          # Retrieve a team's profile.
           #
           # @option options [Object] :visibility
           #   Filter by visibility.

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Usergroups
           #
-          # This method is used to create a User Group.
+          # Create a User Group
           #
           # @option options [Object] :name
           #   A name for the User Group. Must be unique among User Groups.
@@ -26,7 +27,7 @@ module Slack
           end
 
           #
-          # This method disables an existing User Group.
+          # Disable an existing User Group
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to disable.
@@ -40,7 +41,7 @@ module Slack
           end
 
           #
-          # This method enables a User Group which was previously disabled.
+          # Enable a User Group
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to enable.
@@ -54,7 +55,7 @@ module Slack
           end
 
           #
-          # This method returns a list of all User Groups in the team. This can optionally include disabled User Groups.
+          # List all User Groups for a team
           #
           # @option options [Object] :include_count
           #   Include the number of users in each User Group.
@@ -69,7 +70,7 @@ module Slack
           end
 
           #
-          # This method updates the properties of an existing User Group.
+          # Update an existing User Group
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to update.

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module UsergroupsUsers
           #
-          # This method returns a list of all users within a User Group.
+          # List all users in a User Group
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to update.
@@ -20,7 +21,7 @@ module Slack
           end
 
           #
-          # This method updates the list of users that belong to a User Group. This method replaces all users in a User Group with the list of users provided in the users parameter.
+          # Update the list of users for a User Group
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to update.

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Users
           #
-          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
+          # List conversations the calling user may access.
           #
           # @option options [Object] :cursor
           #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
@@ -32,7 +33,7 @@ module Slack
           end
 
           #
-          # This method allows the user to delete their profile image. It will clear whatever image is currently set.
+          # Delete the user profile photo
           #
           # @see https://api.slack.com/methods/users.deletePhoto
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.deletePhoto.json
@@ -41,8 +42,7 @@ module Slack
           end
 
           #
-          # This method lets you find out information about a user's presence.
-          # Consult the presence documentation for more details.
+          # Gets user presence information.
           #
           # @option options [user] :user
           #   User to get presence info on. Defaults to the authed user.
@@ -55,7 +55,7 @@ module Slack
           end
 
           #
-          # After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity.
+          # Get a user's identity.
           #
           # @see https://api.slack.com/methods/users.identity
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.identity.json
@@ -64,7 +64,7 @@ module Slack
           end
 
           #
-          # This method returns information about a member of a workspace.
+          # Gets information about a user.
           #
           # @option options [user] :user
           #   User to get info on.
@@ -79,7 +79,7 @@ module Slack
           end
 
           #
-          # This method returns a list of all users in the workspace. This includes deleted/deactivated users.
+          # Lists all users in a Slack team.
           #
           # @option options [Object] :cursor
           #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
@@ -100,7 +100,7 @@ module Slack
           end
 
           #
-          # Retrieve a single user by looking them up by their registered email address. Requires users:read.email.
+          # Find a user with an email address.
           #
           # @option options [Object] :email
           #   An email address belonging to a user in the workspace.
@@ -112,7 +112,7 @@ module Slack
           end
 
           #
-          # This method is no longer functional and the behavior it controlled is no longer offered. The method will no longer exist beginning May 8, 2018.
+          # Marked a user as active. Deprecated and non-functional.
           #
           # @see https://api.slack.com/methods/users.setActive
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.setActive.json
@@ -121,7 +121,7 @@ module Slack
           end
 
           #
-          # This method allows the user to set their profile image. The caller can pass image data via image.
+          # Set the user profile photo
           #
           # @option options [Object] :image
           #   File contents via multipart/form-data.
@@ -139,8 +139,7 @@ module Slack
           end
 
           #
-          # This method lets you set the calling user's manual presence.
-          # Consult the presence documentation for more details.
+          # Manually sets user presence.
           #
           # @option options [Object] :presence
           #   Either auto or away.

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module UsersProfile
           #
-          # Use this method to retrieve a user's profile information.
+          # Retrieves a user's profile information.
           #
           # @option options [Object] :include_labels
           #   Include labels for each ID in custom profile fields.
@@ -20,7 +21,7 @@ module Slack
           end
 
           #
-          # Use this method to set a user's profile information, including name, email, current status, and other attributes.
+          # Set the profile information for a user.
           #
           # @option options [Object] :name
           #   Name of a single key to set. Usable only if profile is not passed.

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Views
+          #
+          # Open a view for a user.
+          #
+          # @option options [Object] :trigger_id
+          #   Exchange a trigger to post to the user.
+          # @option options [Object] :view
+          #   A view payload. This must be a JSON-encoded string.
+          # @see https://api.slack.com/methods/views.open
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/views/views.open.json
+          def views_open(options = {})
+            throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
+            throw ArgumentError.new('Required arguments :view missing') if options[:view].nil?
+            if options.key?(:view)
+              view = options[:view]
+              view = JSON.dump(view) unless view.is_a?(String)
+              options = options.merge(view: view)
+            end
+            post('views.open', options)
+          end
+
+          #
+          # Publish a static view for a User.
+          #
+          # @option options [Object] :user_id
+          #   id of the user you want publish a view to.
+          # @option options [Object] :view
+          #   A view payload. This must be a JSON-encoded string.
+          # @option options [Object] :hash
+          #   A string that represents view state to protect against possible race conditions.
+          # @see https://api.slack.com/methods/views.publish
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/views/views.publish.json
+          def views_publish(options = {})
+            throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
+            throw ArgumentError.new('Required arguments :view missing') if options[:view].nil?
+            if options.key?(:view)
+              view = options[:view]
+              view = JSON.dump(view) unless view.is_a?(String)
+              options = options.merge(view: view)
+            end
+            post('views.publish', options)
+          end
+
+          #
+          # Push a view onto the stack of a root view.
+          #
+          # @option options [Object] :trigger_id
+          #   Exchange a trigger to post to the user.
+          # @option options [Object] :view
+          #   A view payload. This must be a JSON-encoded string.
+          # @see https://api.slack.com/methods/views.push
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/views/views.push.json
+          def views_push(options = {})
+            throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
+            throw ArgumentError.new('Required arguments :view missing') if options[:view].nil?
+            if options.key?(:view)
+              view = options[:view]
+              view = JSON.dump(view) unless view.is_a?(String)
+              options = options.merge(view: view)
+            end
+            post('views.push', options)
+          end
+
+          #
+          # Update an existing view.
+          #
+          # @option options [Object] :view
+          #   A view payload This must be a JSON-encoded string.
+          # @option options [Object] :external_id
+          #   A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either view_id or external_id is required.
+          # @option options [Object] :hash
+          #   A string that represents view state to protect against possible race conditions.
+          # @option options [Object] :view_id
+          #   A unique identifier of the view to be updated. Either view_id or external_id is required.
+          # @see https://api.slack.com/methods/views.update
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/views/views.update.json
+          def views_update(options = {})
+            throw ArgumentError.new('Required arguments :view missing') if options[:view].nil?
+            if options.key?(:view)
+              view = options[:view]
+              view = JSON.dump(view) unless view.is_a?(String)
+              options = options.merge(view: view)
+            end
+            post('views.update', options)
+          end
+        end
+      end
+    end
+  end
+end