slack-ruby-client 0.15.0 → 1.0.0

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

@@ -9,13 +9,15 @@ module Slack
           #
           # List conversations the calling user may access.
           #
-          # @option options [Object] :cursor
+          # @option options [string] :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.
-          # @option options [Object] :exclude_archived
+          # @option options [boolean] :exclude_archived
           #   Set to true to exclude archived channels from the list.
-          # @option options [Object] :limit
+          # @option options [number] :limit
           #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.
-          # @option options [Object] :types
+          # @option options [string] :team_id
+          #   encoded team id to list conversations in, required if org token is used.
+          # @option options [string] :types
           #   Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.
           # @option options [user] :user
           #   Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.
@@ -49,7 +51,6 @@ module Slack
           # @see https://api.slack.com/methods/users.getPresence
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.getPresence.json
           def users_getPresence(options = {})
-            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('users.getPresence', options)
           end
@@ -68,7 +69,7 @@ module Slack
           #
           # @option options [user] :user
           #   User to get info on.
-          # @option options [Object] :include_locale
+          # @option options [boolean] :include_locale
           #   Set this to true to receive the locale for this user. Defaults to false.
           # @see https://api.slack.com/methods/users.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.info.json
@@ -81,12 +82,14 @@ module Slack
           #
           # Lists all users in a Slack team.
           #
-          # @option options [Object] :cursor
+          # @option options [string] :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.
-          # @option options [Object] :include_locale
+          # @option options [boolean] :include_locale
           #   Set this to true to receive the locale for users. Defaults to false.
-          # @option options [Object] :limit
-          #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
+          # @option options [number] :limit
+          #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no limit value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience limit_required or HTTP 500 errors.
+          # @option options [string] :team_id
+          #   encoded team id to list users in, required if org token is used.
           # @see https://api.slack.com/methods/users.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.list.json
           def users_list(options = {})
@@ -102,7 +105,7 @@ module Slack
           #
           # Find a user with an email address.
           #
-          # @option options [Object] :email
+          # @option options [string] :email
           #   An email address belonging to a user in the workspace.
           # @see https://api.slack.com/methods/users.lookupByEmail
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.lookupByEmail.json
@@ -123,25 +126,24 @@ module Slack
           #
           # Set the user profile photo
           #
-          # @option options [Object] :image
-          #   File contents via multipart/form-data.
-          # @option options [Object] :crop_w
+          # @option options [string] :crop_w
           #   Width/height of crop box (always square).
-          # @option options [Object] :crop_x
+          # @option options [string] :crop_x
           #   X coordinate of top-left corner of crop box.
-          # @option options [Object] :crop_y
+          # @option options [string] :crop_y
           #   Y coordinate of top-left corner of crop box.
+          # @option options [string] :image
+          #   File contents via multipart/form-data.
           # @see https://api.slack.com/methods/users.setPhoto
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.setPhoto.json
           def users_setPhoto(options = {})
-            throw ArgumentError.new('Required arguments :image missing') if options[:image].nil?
             post('users.setPhoto', options)
           end
 
           #
           # Manually sets user presence.
           #
-          # @option options [Object] :presence
+          # @option options [string] :presence
           #   Either auto or away.
           # @see https://api.slack.com/methods/users.setPresence
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.setPresence.json

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

@@ -7,10 +7,10 @@ module Slack
       module Endpoints
         module UsersProfile
           #
-          # Retrieves a user's profile information.
+          # Retrieve a user's profile information, including their custom status.
           #
-          # @option options [Object] :include_labels
-          #   Include labels for each ID in custom profile fields.
+          # @option options [boolean] :include_labels
+          #   Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended.
           # @option options [user] :user
           #   User to retrieve profile info for.
           # @see https://api.slack.com/methods/users.profile.get
@@ -21,15 +21,15 @@ module Slack
           end
 
           #
-          # Set the profile information for a user.
+          # Set a user's profile information, including custom status.
           #
-          # @option options [Object] :name
+          # @option options [string] :name
           #   Name of a single key to set. Usable only if profile is not passed.
-          # @option options [Object] :profile
+          # @option options [string] :profile
           #   Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.
           # @option options [user] :user
           #   ID of user to change. This argument may only be specified by team admins on paid teams.
-          # @option options [Object] :value
+          # @option options [string] :value
           #   Value to set a single key to. Usable only if profile is not passed.
           # @see https://api.slack.com/methods/users.profile.set
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users.profile/users.profile.set.json

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

@@ -9,9 +9,9 @@ module Slack
           #
           # Open a view for a user.
           #
-          # @option options [Object] :trigger_id
+          # @option options [string] :trigger_id
           #   Exchange a trigger to post to the user.
-          # @option options [Object] :view
+          # @option options [view as string] :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
@@ -29,11 +29,11 @@ module Slack
           #
           # Publish a static view for a User.
           #
-          # @option options [Object] :user_id
+          # @option options [string] :user_id
           #   id of the user you want publish a view to.
-          # @option options [Object] :view
+          # @option options [view as string] :view
           #   A view payload. This must be a JSON-encoded string.
-          # @option options [Object] :hash
+          # @option options [string] :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
@@ -51,9 +51,9 @@ module Slack
           #
           # Push a view onto the stack of a root view.
           #
-          # @option options [Object] :trigger_id
+          # @option options [string] :trigger_id
           #   Exchange a trigger to post to the user.
-          # @option options [Object] :view
+          # @option options [view as string] :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
@@ -71,14 +71,14 @@ module Slack
           #
           # Update an existing view.
           #
-          # @option options [Object] :view
-          #   A view payload This must be a JSON-encoded string.
-          # @option options [Object] :external_id
+          # @option options [view as string] :view
+          #   A view object. This must be a JSON-encoded string.
+          # @option options [string] :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
+          # @option options [string] :view_id
           #   A unique identifier of the view to be updated. Either view_id or external_id is required.
+          # @option options [string] :hash
+          #   A string that represents view state to protect against possible race conditions.
           # @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 = {})

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Workflows
+          #
+          # Indicate that an app's step in a workflow completed execution.
+          #
+          # @option options [string] :workflow_step_execute_id
+          #   Context identifier that maps to the correct workflow step execution.
+          # @option options [object] :outputs
+          #   Key-value object of outputs from your step. Keys of this object reflect the configured key properties of your outputs array from your workflow_step object.
+          # @see https://api.slack.com/methods/workflows.stepCompleted
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/workflows/workflows.stepCompleted.json
+          def workflows_stepCompleted(options = {})
+            throw ArgumentError.new('Required arguments :workflow_step_execute_id missing') if options[:workflow_step_execute_id].nil?
+            post('workflows.stepCompleted', options)
+          end
+
+          #
+          # Indicate that an app's step in a workflow failed to execute.
+          #
+          # @option options [object] :error
+          #   A JSON-based object with a message property that should contain a human readable error message.
+          # @option options [string] :workflow_step_execute_id
+          #   Context identifier that maps to the correct workflow step execution.
+          # @see https://api.slack.com/methods/workflows.stepFailed
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/workflows/workflows.stepFailed.json
+          def workflows_stepFailed(options = {})
+            throw ArgumentError.new('Required arguments :error missing') if options[:error].nil?
+            throw ArgumentError.new('Required arguments :workflow_step_execute_id missing') if options[:workflow_step_execute_id].nil?
+            post('workflows.stepFailed', options)
+          end
+
+          #
+          # Update the configuration for a workflow step.
+          #
+          # @option options [string] :workflow_step_edit_id
+          #   A context identifier provided with view_submission payloads used to call back to workflows.updateStep.
+          # @option options [object] :inputs
+          #   A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. Please note: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. Read more about variables in workflow steps here.
+          # @option options [array] :outputs
+          #   An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.
+          # @option options [string] :step_image_url
+          #   An optional field that can be used to override app image that is shown in the Workflow Builder.
+          # @option options [string] :step_name
+          #   An optional field that can be used to override the step name that is shown in the Workflow Builder.
+          # @see https://api.slack.com/methods/workflows.updateStep
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/workflows/workflows.updateStep.json
+          def workflows_updateStep(options = {})
+            throw ArgumentError.new('Required arguments :workflow_step_edit_id missing') if options[:workflow_step_edit_id].nil?
+            post('workflows.updateStep', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
+require_relative 'endpoints/admin_analytics'
 require_relative 'endpoints/admin_apps'
 require_relative 'endpoints/admin_apps_approved'
 require_relative 'endpoints/admin_apps_requests'
 require_relative 'endpoints/admin_apps_restricted'
+require_relative 'endpoints/admin_auth_policy'
+require_relative 'endpoints/admin_barriers'
 require_relative 'endpoints/admin_conversations'
+require_relative 'endpoints/admin_conversations_ekm'
 require_relative 'endpoints/admin_conversations_restrictAccess'
-require_relative 'endpoints/admin_conversations_whitelist'
 require_relative 'endpoints/admin_emoji'
 require_relative 'endpoints/admin_inviteRequests'
 require_relative 'endpoints/admin_inviteRequests_approved'
@@ -21,15 +24,14 @@ require_relative 'endpoints/admin_users'
 require_relative 'endpoints/admin_users_session'
 require_relative 'endpoints/api'
 require_relative 'endpoints/apps'
-require_relative 'endpoints/apps_permissions'
-require_relative 'endpoints/apps_permissions_resources'
-require_relative 'endpoints/apps_permissions_scopes'
-require_relative 'endpoints/apps_permissions_users'
+require_relative 'endpoints/apps_connections'
+require_relative 'endpoints/apps_event_authorizations'
+require_relative 'endpoints/apps_manifest'
 require_relative 'endpoints/auth'
+require_relative 'endpoints/auth_teams'
 require_relative 'endpoints/bots'
 require_relative 'endpoints/calls'
 require_relative 'endpoints/calls_participants'
-require_relative 'endpoints/channels'
 require_relative 'endpoints/chat'
 require_relative 'endpoints/chat_scheduledMessages'
 require_relative 'endpoints/conversations'
@@ -39,12 +41,10 @@ require_relative 'endpoints/emoji'
 require_relative 'endpoints/files'
 require_relative 'endpoints/files_comments'
 require_relative 'endpoints/files_remote'
-require_relative 'endpoints/groups'
-require_relative 'endpoints/im'
 require_relative 'endpoints/migration'
-require_relative 'endpoints/mpim'
 require_relative 'endpoints/oauth'
 require_relative 'endpoints/oauth_v2'
+require_relative 'endpoints/openid_connect'
 require_relative 'endpoints/pins'
 require_relative 'endpoints/reactions'
 require_relative 'endpoints/reminders'
@@ -52,7 +52,10 @@ require_relative 'endpoints/rtm'
 require_relative 'endpoints/search'
 require_relative 'endpoints/stars'
 require_relative 'endpoints/team'
+require_relative 'endpoints/team_billing'
+require_relative 'endpoints/team_preferences'
 require_relative 'endpoints/team_profile'
+require_relative 'endpoints/tooling_tokens'
 require_relative 'endpoints/usergroups'
 require_relative 'endpoints/usergroups_users'
 require_relative 'endpoints/users'
@@ -60,23 +63,25 @@ require_relative 'endpoints/users_admin'
 require_relative 'endpoints/users_prefs'
 require_relative 'endpoints/users_profile'
 require_relative 'endpoints/views'
+require_relative 'endpoints/workflows'
 
 module Slack
   module Web
     module Api
       module Endpoints
         include Slack::Web::Api::Mixins::Conversations
-        include Slack::Web::Api::Mixins::Channels
         include Slack::Web::Api::Mixins::Users
-        include Slack::Web::Api::Mixins::Groups
 
+        include AdminAnalytics
         include AdminApps
         include AdminAppsApproved
         include AdminAppsRequests
         include AdminAppsRestricted
+        include AdminAuthPolicy
+        include AdminBarriers
         include AdminConversations
+        include AdminConversationsEkm
         include AdminConversationsRestrictaccess
-        include AdminConversationsWhitelist
         include AdminEmoji
         include AdminInviterequests
         include AdminInviterequestsApproved
@@ -90,15 +95,14 @@ module Slack
         include AdminUsersSession
         include Api
         include Apps
-        include AppsPermissions
-        include AppsPermissionsResources
-        include AppsPermissionsScopes
-        include AppsPermissionsUsers
+        include AppsConnections
+        include AppsEventAuthorizations
+        include AppsManifest
         include Auth
+        include AuthTeams
         include Bots
         include Calls
         include CallsParticipants
-        include Channels
         include Chat
         include ChatScheduledmessages
         include Conversations
@@ -108,12 +112,10 @@ module Slack
         include Files
         include FilesComments
         include FilesRemote
-        include Groups
-        include Im
         include Migration
-        include Mpim
         include Oauth
         include OauthV2
+        include OpenidConnect
         include Pins
         include Reactions
         include Reminders
@@ -121,7 +123,10 @@ module Slack
         include Search
         include Stars
         include Team
+        include TeamBilling
+        include TeamPreferences
         include TeamProfile
+        include ToolingTokens
         include Usergroups
         include UsergroupsUsers
         include Users
@@ -129,6 +134,7 @@ module Slack
         include UsersPrefs
         include UsersProfile
         include Views
+        include Workflows
       end
     end
   end

data/lib/slack/web/api/errors/server_error.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module Slack
+  module Web
+    module Api
+      module Errors
+        class ServerError < ::Faraday::Error
+          attr_reader :response
+
+          def initialize(message, response)
+            @response = response
+            super message
+          end
+        end
+
+        class ParsingError < ServerError
+          def initialize(response)
+            super('parsing_error', response)
+          end
+        end
+
+        class HttpRequestError < ServerError; end
+
+        class TimeoutError < HttpRequestError
+          def initialize(response)
+            super('timeout_error', response)
+          end
+        end
+
+        class UnavailableError < HttpRequestError
+          def initialize(response)
+            super('unavailable_error', response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/errors/too_many_requests_error.rb

@@ -8,10 +8,7 @@ module Slack
 
           def initialize(response)
             @response = response
-          end
-
-          def message
-            "Retry after #{retry_after} seconds"
+            super "Retry after #{retry_after} seconds"
           end
 
           def retry_after