slack-ruby-client 0.13.1 → 2.0.0

data/lib/slack/real_time/stores.rb

@@ -1,10 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'stores/base'
 require_relative 'stores/starter'
 require_relative 'stores/store'
-
-module Slack
-  module RealTime
-    class Store < Stores::Store
-    end
-  end
-end

data/lib/slack/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
-  VERSION = '0.13.1'.freeze
+  VERSION = '2.0.0'
 end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAnalytics
+          #
+          # Retrieve analytics data for a given date, presented as a compressed JSON file
+          #
+          # @option options [string] :type
+          #   The type of analytics to retrieve. The options are currently limited to member (for grid member analytics) and public_channel (for public channel analytics).
+          # @option options [date] :date
+          #   Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC.
+          # @option options [boolean] :metadata_only
+          #   Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.
+          # @see https://api.slack.com/methods/admin.analytics.getFile
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.analytics/admin.analytics.getFile.json
+          def admin_analytics_getFile(options = {})
+            raise ArgumentError, 'Required arguments :type missing' if options[:type].nil?
+            post('admin.analytics.getFile', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminApps
+          #
+          # Approve an app for installation on a workspace.
+          #
+          # @option options [string] :app_id
+          #   The id of the app to approve.
+          # @option options [Object] :enterprise_id
+          #   The ID of the enterprise to approve the app on.
+          # @option options [string] :request_id
+          #   The id of the request to approve.
+          # @option options [Object] :team_id
+          #   The ID of the workspace to approve the app on.
+          # @see https://api.slack.com/methods/admin.apps.approve
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.approve.json
+          def admin_apps_approve(options = {})
+            post('admin.apps.approve', options)
+          end
+
+          #
+          # Clear an app resolution
+          #
+          # @option options [string] :app_id
+          #   The id of the app whose resolution you want to clear/undo.
+          # @option options [Object] :enterprise_id
+          #   The enterprise to clear the app resolution from.
+          # @option options [Object] :team_id
+          #   The workspace to clear the app resolution from.
+          # @see https://api.slack.com/methods/admin.apps.clearResolution
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.clearResolution.json
+          def admin_apps_clearResolution(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            post('admin.apps.clearResolution', options)
+          end
+
+          #
+          # Restrict an app for installation on a workspace.
+          #
+          # @option options [string] :app_id
+          #   The id of the app to restrict.
+          # @option options [Object] :enterprise_id
+          #   The ID of the enterprise to approve the app on.
+          # @option options [string] :request_id
+          #   The id of the request to restrict.
+          # @option options [Object] :team_id
+          #   The ID of the workspace to approve the app on.
+          # @see https://api.slack.com/methods/admin.apps.restrict
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.restrict.json
+          def admin_apps_restrict(options = {})
+            post('admin.apps.restrict', options)
+          end
+
+          #
+          # Uninstall an app from one or many workspaces, or an entire enterprise organization.
+          #
+          # @option options [string] :app_id
+          #   The ID of the app to uninstall.
+          # @option options [string] :enterprise_id
+          #   The enterprise to completely uninstall the application from (across all workspaces). With an org-level token, this or team_ids is required.
+          # @option options [string] :team_ids
+          #   IDs of the teams to uninstall from (max 100). With an org-level token, this or enterprise_id is required.
+          # @see https://api.slack.com/methods/admin.apps.uninstall
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.uninstall.json
+          def admin_apps_uninstall(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            post('admin.apps.uninstall', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAppsApproved
+          #
+          # List approved apps for an org or workspace.
+          #
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :enterprise_id
+          #   .
+          # @option options [integer] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [Object] :team_id
+          #   .
+          # @see https://api.slack.com/methods/admin.apps.approved.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.approved/admin.apps.approved.list.json
+          def admin_apps_approved_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_apps_approved_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.apps.approved.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAppsRequests
+          #
+          # Cancel approval request for team
+          #
+          # @option options [string] :request_id
+          #   The id of the request to cancel.
+          # @option options [Object] :enterprise_id
+          #   The ID of the enterprise where this request belongs.
+          # @option options [Object] :team_id
+          #   The ID of the workspace where this request belongs.
+          # @see https://api.slack.com/methods/admin.apps.requests.cancel
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.requests/admin.apps.requests.cancel.json
+          def admin_apps_requests_cancel(options = {})
+            raise ArgumentError, 'Required arguments :request_id missing' if options[:request_id].nil?
+            post('admin.apps.requests.cancel', options)
+          end
+
+          #
+          # List app requests for a team/workspace.
+          #
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :enterprise_id
+          #   .
+          # @option options [integer] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [Object] :team_id
+          #   .
+          # @see https://api.slack.com/methods/admin.apps.requests.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.requests/admin.apps.requests.list.json
+          def admin_apps_requests_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_apps_requests_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.apps.requests.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAppsRestricted
+          #
+          # List restricted apps for an org or workspace.
+          #
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :enterprise_id
+          #   .
+          # @option options [integer] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [Object] :team_id
+          #   .
+          # @see https://api.slack.com/methods/admin.apps.restricted.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.restricted/admin.apps.restricted.list.json
+          def admin_apps_restricted_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_apps_restricted_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.apps.restricted.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/admin_audit_anomaly_allow.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 AdminAuditAnomalyAllow
+          #
+          # API to allow enterprise grid admins to read the allow list of IP blocks and ASNs from the enterprise configuration.
+          #
+          # @see https://api.slack.com/methods/admin.audit.anomaly.allow.getItem
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.audit.anomaly.allow/admin.audit.anomaly.allow.getItem.json
+          def admin_audit_anomaly_allow_getItem(options = {})
+            post('admin.audit.anomaly.allow.getItem', options)
+          end
+
+          #
+          # API to allow enterprise grid admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration.
+          #
+          # @option options [array] :trusted_asns
+          #   allow list of Autonomous System Numbers (ASN) in the enterprise grid configuarion.
+          # @option options [array] :trusted_cidr
+          #   allow list of IPv4 addressses using cidr notation in the enterprise grid configuarion.
+          # @see https://api.slack.com/methods/admin.audit.anomaly.allow.updateItem
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.audit.anomaly.allow/admin.audit.anomaly.allow.updateItem.json
+          def admin_audit_anomaly_allow_updateItem(options = {})
+            post('admin.audit.anomaly.allow.updateItem', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAuthPolicy
+          #
+          # Assign entities to a particular authentication policy.
+          #
+          # @option options [array] :entity_ids
+          #   Array of IDs to assign to the policy.
+          # @option options [Object] :entity_type
+          #   The type of entity to assign to the policy. Currently, USER is supported.
+          # @option options [string] :policy_name
+          #   The name of the authentication policy to assign the entities to. Currently, email_password is the only policy that may be used with this method.
+          # @see https://api.slack.com/methods/admin.auth.policy.assignEntities
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.auth.policy/admin.auth.policy.assignEntities.json
+          def admin_auth_policy_assignEntities(options = {})
+            raise ArgumentError, 'Required arguments :entity_ids missing' if options[:entity_ids].nil?
+            raise ArgumentError, 'Required arguments :entity_type missing' if options[:entity_type].nil?
+            raise ArgumentError, 'Required arguments :policy_name missing' if options[:policy_name].nil?
+            post('admin.auth.policy.assignEntities', options)
+          end
+
+          #
+          # Fetch all the entities assigned to a particular authentication policy by name.
+          #
+          # @option options [string] :policy_name
+          #   The name of the policy to fetch entities for. Currently, email_password is the only policy that may be used with this method.
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :entity_type
+          #   The type of entity to assign to the policy. Currently, USER is supported.
+          # @option options [integer] :limit
+          #   The maximum number of items to return. Must be between 1 and 1000, both inclusive.
+          # @see https://api.slack.com/methods/admin.auth.policy.getEntities
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.auth.policy/admin.auth.policy.getEntities.json
+          def admin_auth_policy_getEntities(options = {})
+            raise ArgumentError, 'Required arguments :policy_name missing' if options[:policy_name].nil?
+            if block_given?
+              Pagination::Cursor.new(self, :admin_auth_policy_getEntities, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.auth.policy.getEntities', options)
+            end
+          end
+
+          #
+          # Remove specified entities from a specified authentication policy.
+          #
+          # @option options [array] :entity_ids
+          #   Encoded IDs of the entities you'd like to remove from the policy.
+          # @option options [Object] :entity_type
+          #   The type of entity to assign to the policy. Currently, USER is supported.
+          # @option options [string] :policy_name
+          #   The name of the policy to remove entities from. Currently, email_password is the only policy that may be used with this method.
+          # @see https://api.slack.com/methods/admin.auth.policy.removeEntities
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.auth.policy/admin.auth.policy.removeEntities.json
+          def admin_auth_policy_removeEntities(options = {})
+            raise ArgumentError, 'Required arguments :entity_ids missing' if options[:entity_ids].nil?
+            raise ArgumentError, 'Required arguments :entity_type missing' if options[:entity_type].nil?
+            raise ArgumentError, 'Required arguments :policy_name missing' if options[:policy_name].nil?
+            post('admin.auth.policy.removeEntities', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminBarriers
+          #
+          # Create an Information Barrier
+          #
+          # @option options [array] :barriered_from_usergroup_ids
+          #   A list of IDP Groups ids that the primary usergroup is to be barriered from.
+          # @option options [Object] :primary_usergroup_id
+          #   The id of the primary IDP Group.
+          # @option options [array] :restricted_subjects
+          #   What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.
+          # @see https://api.slack.com/methods/admin.barriers.create
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.barriers/admin.barriers.create.json
+          def admin_barriers_create(options = {})
+            raise ArgumentError, 'Required arguments :barriered_from_usergroup_ids missing' if options[:barriered_from_usergroup_ids].nil?
+            raise ArgumentError, 'Required arguments :primary_usergroup_id missing' if options[:primary_usergroup_id].nil?
+            raise ArgumentError, 'Required arguments :restricted_subjects missing' if options[:restricted_subjects].nil?
+            post('admin.barriers.create', options)
+          end
+
+          #
+          # Delete an existing Information Barrier
+          #
+          # @option options [Object] :barrier_id
+          #   The ID of the barrier you're trying to delete.
+          # @see https://api.slack.com/methods/admin.barriers.delete
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.barriers/admin.barriers.delete.json
+          def admin_barriers_delete(options = {})
+            raise ArgumentError, 'Required arguments :barrier_id missing' if options[:barrier_id].nil?
+            post('admin.barriers.delete', options)
+          end
+
+          #
+          # Get all Information Barriers for your organization
+          #
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [integer] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @see https://api.slack.com/methods/admin.barriers.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.barriers/admin.barriers.list.json
+          def admin_barriers_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_barriers_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.barriers.list', options)
+            end
+          end
+
+          #
+          # Update an existing Information Barrier
+          #
+          # @option options [Object] :barrier_id
+          #   The ID of the barrier you're trying to modify.
+          # @option options [array] :barriered_from_usergroup_ids
+          #   A list of IDP Groups ids that the primary usergroup is to be barriered from.
+          # @option options [Object] :primary_usergroup_id
+          #   The id of the primary IDP Group.
+          # @option options [array] :restricted_subjects
+          #   What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.
+          # @see https://api.slack.com/methods/admin.barriers.update
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.barriers/admin.barriers.update.json
+          def admin_barriers_update(options = {})
+            raise ArgumentError, 'Required arguments :barrier_id missing' if options[:barrier_id].nil?
+            raise ArgumentError, 'Required arguments :barriered_from_usergroup_ids missing' if options[:barriered_from_usergroup_ids].nil?
+            raise ArgumentError, 'Required arguments :primary_usergroup_id missing' if options[:primary_usergroup_id].nil?
+            raise ArgumentError, 'Required arguments :restricted_subjects missing' if options[:restricted_subjects].nil?
+            post('admin.barriers.update', options)
+          end
+        end
+      end
+    end
+  end
+end