slack-ruby-client 0.13.1 → 2.0.0

data/lib/slack/web/api/endpoints/apps_manifest.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 AppsManifest
+          #
+          # Create an app from an app manifest.
+          #
+          # @option options [manifest object as string] :manifest
+          #   A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one.
+          # @see https://api.slack.com/methods/apps.manifest.create
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.manifest/apps.manifest.create.json
+          def apps_manifest_create(options = {})
+            raise ArgumentError, 'Required arguments :manifest missing' if options[:manifest].nil?
+            post('apps.manifest.create', options)
+          end
+
+          #
+          # Permanently deletes an app created through app manifests
+          #
+          # @option options [Object] :app_id
+          #   The ID of the app you want to delete.
+          # @see https://api.slack.com/methods/apps.manifest.delete
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.manifest/apps.manifest.delete.json
+          def apps_manifest_delete(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            post('apps.manifest.delete', options)
+          end
+
+          #
+          # Export an app manifest from an existing app
+          #
+          # @option options [Object] :app_id
+          #   The ID of the app whose configuration you want to export as a manifest.
+          # @see https://api.slack.com/methods/apps.manifest.export
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.manifest/apps.manifest.export.json
+          def apps_manifest_export(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            post('apps.manifest.export', options)
+          end
+
+          #
+          # Update an app from an app manifest
+          #
+          # @option options [Object] :app_id
+          #   The ID of the app whose configuration you want to update.
+          # @option options [manifest object as string] :manifest
+          #   A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one. As this method entirely replaces any previous configuration, manifest must contain both unmodified and modified fields.
+          # @see https://api.slack.com/methods/apps.manifest.update
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.manifest/apps.manifest.update.json
+          def apps_manifest_update(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            raise ArgumentError, 'Required arguments :manifest missing' if options[:manifest].nil?
+            post('apps.manifest.update', options)
+          end
+
+          #
+          # Validate an app manifest
+          #
+          # @option options [manifest object as string] :manifest
+          #   The manifest to be validated. Will be validated against the app manifest schema - read our guide.
+          # @option options [Object] :app_id
+          #   The ID of the app whose configuration you want to validate.
+          # @see https://api.slack.com/methods/apps.manifest.validate
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.manifest/apps.manifest.validate.json
+          def apps_manifest_validate(options = {})
+            raise ArgumentError, 'Required arguments :manifest missing' if options[:manifest].nil?
+            post('apps.manifest.validate', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -8,7 +9,7 @@ module Slack
           #
           # Revokes a token.
           #
-          # @option options [Object] :test
+          # @option options [boolean] :test
           #   Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.
           # @see https://api.slack.com/methods/auth.revoke
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/auth/auth.revoke.json

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AuthTeams
+          #
+          # List the workspaces a token can access.
+          #
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [boolean] :include_icon
+          #   Whether to return icon paths for each workspace. An icon path represents a URI pointing to the image signifying the workspace.
+          # @option options [integer] :limit
+          #   The maximum number of workspaces to return. Must be a positive integer no larger than 1000.
+          # @see https://api.slack.com/methods/auth.teams.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/auth.teams/auth.teams.list.json
+          def auth_teams_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :auth_teams_list, options).each do |page|
+                yield page
+              end
+            else
+              post('auth.teams.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Bookmarks
+          #
+          # Add bookmark to a channel.
+          #
+          # @option options [string] :channel_id
+          #   Channel to add bookmark in.
+          # @option options [string] :title
+          #   Title for the bookmark.
+          # @option options [string] :type
+          #   Type of the bookmark i.e link.
+          # @option options [string] :emoji
+          #   Emoji tag to apply to the link.
+          # @option options [string] :entity_id
+          #   ID of the entity being bookmarked. Only applies to message and file types.
+          # @option options [string] :link
+          #   Link to bookmark.
+          # @option options [string] :parent_id
+          #   Id of this bookmark's parent.
+          # @see https://api.slack.com/methods/bookmarks.add
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/bookmarks/bookmarks.add.json
+          def bookmarks_add(options = {})
+            raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
+            raise ArgumentError, 'Required arguments :title missing' if options[:title].nil?
+            raise ArgumentError, 'Required arguments :type missing' if options[:type].nil?
+            post('bookmarks.add', options)
+          end
+
+          #
+          # Edit bookmark.
+          #
+          # @option options [string] :bookmark_id
+          #   Bookmark to update.
+          # @option options [string] :channel_id
+          #   Channel to update bookmark in.
+          # @option options [string] :emoji
+          #   Emoji tag to apply to the link.
+          # @option options [string] :link
+          #   Link to bookmark.
+          # @option options [string] :title
+          #   Title for the bookmark.
+          # @see https://api.slack.com/methods/bookmarks.edit
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/bookmarks/bookmarks.edit.json
+          def bookmarks_edit(options = {})
+            raise ArgumentError, 'Required arguments :bookmark_id missing' if options[:bookmark_id].nil?
+            raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
+            post('bookmarks.edit', options)
+          end
+
+          #
+          # List bookmark for the channel.
+          #
+          # @option options [string] :channel_id
+          #   Channel to list bookmarks in.
+          # @see https://api.slack.com/methods/bookmarks.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/bookmarks/bookmarks.list.json
+          def bookmarks_list(options = {})
+            raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
+            post('bookmarks.list', options)
+          end
+
+          #
+          # Remove bookmark from the channel.
+          #
+          # @option options [string] :bookmark_id
+          #   Bookmark to remove.
+          # @option options [string] :channel_id
+          #   Channel to remove bookmark.
+          # @option options [string] :quip_section_id
+          #   Quip section ID to unbookmark.
+          # @see https://api.slack.com/methods/bookmarks.remove
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/bookmarks/bookmarks.remove.json
+          def bookmarks_remove(options = {})
+            raise ArgumentError, 'Required arguments :bookmark_id missing' if options[:bookmark_id].nil?
+            raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
+            post('bookmarks.remove', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -8,8 +9,10 @@ module Slack
           #
           # Gets information about a bot user.
           #
-          # @option options [Object] :bot
+          # @option options [user] :bot
           #   Bot user to get info on.
+          # @option options [string] :team_id
+          #   encoded team id or enterprise id where the bot exists, required if org token is used.
           # @see https://api.slack.com/methods/bots.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/bots/bots.info.json
           def bots_info(options = {})

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Calls
+          #
+          # Registers a new Call.
+          #
+          # @option options [string] :external_unique_id
+          #   An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.
+          # @option options [string] :join_url
+          #   The URL required for a client to join the Call.
+          # @option options [string] :created_by
+          #   The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required.
+          # @option options [integer] :date_start
+          #   Call start time in UTC UNIX timestamp format.
+          # @option options [string] :desktop_app_join_url
+          #   When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
+          # @option options [string] :external_display_id
+          #   An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.
+          # @option options [string] :title
+          #   The name of the Call.
+          # @option options [array] :users
+          #   The list of users to register as participants in the Call. Read more on how to specify users here.
+          # @see https://api.slack.com/methods/calls.add
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.add.json
+          def calls_add(options = {})
+            raise ArgumentError, 'Required arguments :external_unique_id missing' if options[:external_unique_id].nil?
+            raise ArgumentError, 'Required arguments :join_url missing' if options[:join_url].nil?
+            post('calls.add', options)
+          end
+
+          #
+          # Ends a Call.
+          #
+          # @option options [string] :id
+          #   id returned when registering the call using the calls.add method.
+          # @option options [integer] :duration
+          #   Call duration in seconds.
+          # @see https://api.slack.com/methods/calls.end
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.end.json
+          def calls_end(options = {})
+            raise ArgumentError, 'Required arguments :id missing' if options[:id].nil?
+            post('calls.end', options)
+          end
+
+          #
+          # Returns information about a Call.
+          #
+          # @option options [string] :id
+          #   id of the Call returned by the calls.add method.
+          # @see https://api.slack.com/methods/calls.info
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.info.json
+          def calls_info(options = {})
+            raise ArgumentError, 'Required arguments :id missing' if options[:id].nil?
+            post('calls.info', options)
+          end
+
+          #
+          # Updates information about a Call.
+          #
+          # @option options [string] :id
+          #   id returned by the calls.add method.
+          # @option options [string] :desktop_app_join_url
+          #   When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
+          # @option options [string] :join_url
+          #   The URL required for a client to join the Call.
+          # @option options [string] :title
+          #   The name of the Call.
+          # @see https://api.slack.com/methods/calls.update
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.update.json
+          def calls_update(options = {})
+            raise ArgumentError, 'Required arguments :id missing' if options[:id].nil?
+            post('calls.update', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module CallsParticipants
+          #
+          # Registers new participants added to a Call.
+          #
+          # @option options [string] :id
+          #   id returned by the calls.add method.
+          # @option options [array] :users
+          #   The list of users to add as participants in the Call. Read more on how to specify users here.
+          # @see https://api.slack.com/methods/calls.participants.add
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls.participants/calls.participants.add.json
+          def calls_participants_add(options = {})
+            raise ArgumentError, 'Required arguments :id missing' if options[:id].nil?
+            raise ArgumentError, 'Required arguments :users missing' if options[:users].nil?
+            post('calls.participants.add', options)
+          end
+
+          #
+          # Registers participants removed from a Call.
+          #
+          # @option options [string] :id
+          #   id returned by the calls.add method.
+          # @option options [array] :users
+          #   The list of users to remove as participants in the Call. Read more on how to specify users here.
+          # @see https://api.slack.com/methods/calls.participants.remove
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls.participants/calls.participants.remove.json
+          def calls_participants_remove(options = {})
+            raise ArgumentError, 'Required arguments :id missing' if options[:id].nil?
+            raise ArgumentError, 'Required arguments :users missing' if options[:users].nil?
+            post('calls.participants.remove', options)
+          end
+        end
+      end
+    end
+  end
+end