slackapi-sdk 1.0.0

data/lib/slack_web_api/client.rb

@@ -0,0 +1,410 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  #  slack_web_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Returns the configured authentication slackAuth instance.
+    def slack_auth
+      @auth_managers['slackAuth']
+    end
+
+    # Access to admin_apps controller.
+    # @return [AdminAppsController] Returns the controller instance.
+    def admin_apps
+      @admin_apps ||= AdminAppsController.new @global_configuration
+    end
+
+    # Access to admin_apps_approved controller.
+    # @return [AdminAppsApprovedController] Returns the controller instance.
+    def admin_apps_approved
+      @admin_apps_approved ||= AdminAppsApprovedController.new @global_configuration
+    end
+
+    # Access to admin_apps_requests controller.
+    # @return [AdminAppsRequestsController] Returns the controller instance.
+    def admin_apps_requests
+      @admin_apps_requests ||= AdminAppsRequestsController.new @global_configuration
+    end
+
+    # Access to admin_apps_restricted controller.
+    # @return [AdminAppsRestrictedController] Returns the controller instance.
+    def admin_apps_restricted
+      @admin_apps_restricted ||= AdminAppsRestrictedController.new @global_configuration
+    end
+
+    # Access to admin_conversations controller.
+    # @return [AdminConversationsController] Returns the controller instance.
+    def admin_conversations
+      @admin_conversations ||= AdminConversationsController.new @global_configuration
+    end
+
+    # Access to admin_conversations_ekm controller.
+    # @return [AdminConversationsEkmController] Returns the controller instance.
+    def admin_conversations_ekm
+      @admin_conversations_ekm ||= AdminConversationsEkmController.new @global_configuration
+    end
+
+    # Access to admin_conversations_restrict_access controller.
+    # @return [AdminConversationsRestrictAccessController] Returns the controller instance.
+    def admin_conversations_restrict_access
+      @admin_conversations_restrict_access ||= AdminConversationsRestrictAccessController.new @global_configuration
+    end
+
+    # Access to admin_emoji controller.
+    # @return [AdminEmojiController] Returns the controller instance.
+    def admin_emoji
+      @admin_emoji ||= AdminEmojiController.new @global_configuration
+    end
+
+    # Access to admin_invite_requests controller.
+    # @return [AdminInviteRequestsController] Returns the controller instance.
+    def admin_invite_requests
+      @admin_invite_requests ||= AdminInviteRequestsController.new @global_configuration
+    end
+
+    # Access to admin_invite_requests_approved controller.
+    # @return [AdminInviteRequestsApprovedController] Returns the controller instance.
+    def admin_invite_requests_approved
+      @admin_invite_requests_approved ||= AdminInviteRequestsApprovedController.new @global_configuration
+    end
+
+    # Access to admin_invite_requests_denied controller.
+    # @return [AdminInviteRequestsDeniedController] Returns the controller instance.
+    def admin_invite_requests_denied
+      @admin_invite_requests_denied ||= AdminInviteRequestsDeniedController.new @global_configuration
+    end
+
+    # Access to admin_teams_admins controller.
+    # @return [AdminTeamsAdminsController] Returns the controller instance.
+    def admin_teams_admins
+      @admin_teams_admins ||= AdminTeamsAdminsController.new @global_configuration
+    end
+
+    # Access to admin_teams controller.
+    # @return [AdminTeamsController] Returns the controller instance.
+    def admin_teams
+      @admin_teams ||= AdminTeamsController.new @global_configuration
+    end
+
+    # Access to admin_teams_owners controller.
+    # @return [AdminTeamsOwnersController] Returns the controller instance.
+    def admin_teams_owners
+      @admin_teams_owners ||= AdminTeamsOwnersController.new @global_configuration
+    end
+
+    # Access to admin_teams_settings controller.
+    # @return [AdminTeamsSettingsController] Returns the controller instance.
+    def admin_teams_settings
+      @admin_teams_settings ||= AdminTeamsSettingsController.new @global_configuration
+    end
+
+    # Access to admin_usergroups controller.
+    # @return [AdminUsergroupsController] Returns the controller instance.
+    def admin_usergroups
+      @admin_usergroups ||= AdminUsergroupsController.new @global_configuration
+    end
+
+    # Access to admin_users controller.
+    # @return [AdminUsersController] Returns the controller instance.
+    def admin_users
+      @admin_users ||= AdminUsersController.new @global_configuration
+    end
+
+    # Access to admin_users_session controller.
+    # @return [AdminUsersSessionController] Returns the controller instance.
+    def admin_users_session
+      @admin_users_session ||= AdminUsersSessionController.new @global_configuration
+    end
+
+    # Access to api controller.
+    # @return [ApiController] Returns the controller instance.
+    def api
+      @api ||= ApiController.new @global_configuration
+    end
+
+    # Access to apps_event_authorizations controller.
+    # @return [AppsEventAuthorizationsController] Returns the controller instance.
+    def apps_event_authorizations
+      @apps_event_authorizations ||= AppsEventAuthorizationsController.new @global_configuration
+    end
+
+    # Access to apps_permissions controller.
+    # @return [AppsPermissionsController] Returns the controller instance.
+    def apps_permissions
+      @apps_permissions ||= AppsPermissionsController.new @global_configuration
+    end
+
+    # Access to apps_permissions_resources controller.
+    # @return [AppsPermissionsResourcesController] Returns the controller instance.
+    def apps_permissions_resources
+      @apps_permissions_resources ||= AppsPermissionsResourcesController.new @global_configuration
+    end
+
+    # Access to apps_permissions_scopes controller.
+    # @return [AppsPermissionsScopesController] Returns the controller instance.
+    def apps_permissions_scopes
+      @apps_permissions_scopes ||= AppsPermissionsScopesController.new @global_configuration
+    end
+
+    # Access to apps_permissions_users controller.
+    # @return [AppsPermissionsUsersController] Returns the controller instance.
+    def apps_permissions_users
+      @apps_permissions_users ||= AppsPermissionsUsersController.new @global_configuration
+    end
+
+    # Access to apps controller.
+    # @return [AppsController] Returns the controller instance.
+    def apps
+      @apps ||= AppsController.new @global_configuration
+    end
+
+    # Access to auth controller.
+    # @return [AuthController] Returns the controller instance.
+    def auth
+      @auth ||= AuthController.new @global_configuration
+    end
+
+    # Access to bots controller.
+    # @return [BotsController] Returns the controller instance.
+    def bots
+      @bots ||= BotsController.new @global_configuration
+    end
+
+    # Access to calls controller.
+    # @return [CallsController] Returns the controller instance.
+    def calls
+      @calls ||= CallsController.new @global_configuration
+    end
+
+    # Access to calls_participants controller.
+    # @return [CallsParticipantsController] Returns the controller instance.
+    def calls_participants
+      @calls_participants ||= CallsParticipantsController.new @global_configuration
+    end
+
+    # Access to chat controller.
+    # @return [ChatController] Returns the controller instance.
+    def chat
+      @chat ||= ChatController.new @global_configuration
+    end
+
+    # Access to chat_scheduled_messages controller.
+    # @return [ChatScheduledMessagesController] Returns the controller instance.
+    def chat_scheduled_messages
+      @chat_scheduled_messages ||= ChatScheduledMessagesController.new @global_configuration
+    end
+
+    # Access to conversations controller.
+    # @return [ConversationsController] Returns the controller instance.
+    def conversations
+      @conversations ||= ConversationsController.new @global_configuration
+    end
+
+    # Access to dialog controller.
+    # @return [DialogController] Returns the controller instance.
+    def dialog
+      @dialog ||= DialogController.new @global_configuration
+    end
+
+    # Access to dnd controller.
+    # @return [DndController] Returns the controller instance.
+    def dnd
+      @dnd ||= DndController.new @global_configuration
+    end
+
+    # Access to emoji controller.
+    # @return [EmojiController] Returns the controller instance.
+    def emoji
+      @emoji ||= EmojiController.new @global_configuration
+    end
+
+    # Access to files_comments controller.
+    # @return [FilesCommentsController] Returns the controller instance.
+    def files_comments
+      @files_comments ||= FilesCommentsController.new @global_configuration
+    end
+
+    # Access to files controller.
+    # @return [FilesController] Returns the controller instance.
+    def files
+      @files ||= FilesController.new @global_configuration
+    end
+
+    # Access to files_remote controller.
+    # @return [FilesRemoteController] Returns the controller instance.
+    def files_remote
+      @files_remote ||= FilesRemoteController.new @global_configuration
+    end
+
+    # Access to migration controller.
+    # @return [MigrationController] Returns the controller instance.
+    def migration
+      @migration ||= MigrationController.new @global_configuration
+    end
+
+    # Access to oauth controller.
+    # @return [OauthController] Returns the controller instance.
+    def oauth
+      @oauth ||= OauthController.new @global_configuration
+    end
+
+    # Access to oauth_v2 controller.
+    # @return [OauthV2Controller] Returns the controller instance.
+    def oauth_v2
+      @oauth_v2 ||= OauthV2Controller.new @global_configuration
+    end
+
+    # Access to pins controller.
+    # @return [PinsController] Returns the controller instance.
+    def pins
+      @pins ||= PinsController.new @global_configuration
+    end
+
+    # Access to reactions controller.
+    # @return [ReactionsController] Returns the controller instance.
+    def reactions
+      @reactions ||= ReactionsController.new @global_configuration
+    end
+
+    # Access to reminders controller.
+    # @return [RemindersController] Returns the controller instance.
+    def reminders
+      @reminders ||= RemindersController.new @global_configuration
+    end
+
+    # Access to rtm controller.
+    # @return [RtmController] Returns the controller instance.
+    def rtm
+      @rtm ||= RtmController.new @global_configuration
+    end
+
+    # Access to search controller.
+    # @return [SearchController] Returns the controller instance.
+    def search
+      @search ||= SearchController.new @global_configuration
+    end
+
+    # Access to stars controller.
+    # @return [StarsController] Returns the controller instance.
+    def stars
+      @stars ||= StarsController.new @global_configuration
+    end
+
+    # Access to team controller.
+    # @return [TeamController] Returns the controller instance.
+    def team
+      @team ||= TeamController.new @global_configuration
+    end
+
+    # Access to team_profile controller.
+    # @return [TeamProfileController] Returns the controller instance.
+    def team_profile
+      @team_profile ||= TeamProfileController.new @global_configuration
+    end
+
+    # Access to usergroups controller.
+    # @return [UsergroupsController] Returns the controller instance.
+    def usergroups
+      @usergroups ||= UsergroupsController.new @global_configuration
+    end
+
+    # Access to usergroups_users controller.
+    # @return [UsergroupsUsersController] Returns the controller instance.
+    def usergroups_users
+      @usergroups_users ||= UsergroupsUsersController.new @global_configuration
+    end
+
+    # Access to users controller.
+    # @return [UsersController] Returns the controller instance.
+    def users
+      @users ||= UsersController.new @global_configuration
+    end
+
+    # Access to users_profile controller.
+    # @return [UsersProfileController] Returns the controller instance.
+    def users_profile
+      @users_profile ||= UsersProfileController.new @global_configuration
+    end
+
+    # Access to views controller.
+    # @return [ViewsController] Returns the controller instance.
+    def views
+      @views ||= ViewsController.new @global_configuration
+    end
+
+    # Access to workflows controller.
+    # @return [WorkflowsController] Returns the controller instance.
+    def workflows
+      @workflows ||= WorkflowsController.new @global_configuration
+    end
+
+    # Access to oauth_authorization controller.
+    # @return [OauthAuthorizationController] Returns the controller instance.
+    def oauth_authorization
+      @oauth_authorization ||= OauthAuthorizationController.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      authorization_code_auth_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    proxy_settings: proxy_settings,
+                    logging_configuration: logging_configuration,
+                    environment: environment,
+                    authorization_code_auth_credentials: authorization_code_auth_credentials
+                  )
+                else
+                  config
+                end
+      user_agent_params = BaseController.user_agent_parameters
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent,
+                                                             agent_parameters: user_agent_params)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[slackAuth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['slackAuth'] = Oauth2.new(
+        http_client_config.authorization_code_auth_credentials, global_config
+      )
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end

data/lib/slack_web_api/configuration.rb

@@ -0,0 +1,173 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = PRODUCTION)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze,
+      AUTH_SERVER = 'auth server'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'default' then DEFAULT
+      when 'auth_server' then AUTH_SERVER
+
+      else
+        warn "[Server] Unknown server '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :authorization_code_auth_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      authorization_code_auth_credentials: nil
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings,
+            logging_configuration: logging_configuration
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The object holding OAuth 2 Authorization Code Grant credentials
+      @authorization_code_auth_credentials = authorization_code_auth_credentials
+
+      # Initializing OAuth 2 Authorization Code Grant credentials with the provided auth parameters
+      @authorization_code_auth_credentials = authorization_code_auth_credentials
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil, authorization_code_auth_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      logging_configuration ||= self.logging_configuration
+      environment ||= self.environment
+      authorization_code_auth_credentials ||= self.authorization_code_auth_credentials
+
+      Configuration.new(
+        connection: connection, adapter: adapter, timeout: timeout,
+        max_retries: max_retries, retry_interval: retry_interval,
+        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+        retry_methods: retry_methods, http_callback: http_callback,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration, environment: environment,
+        authorization_code_auth_credentials: authorization_code_auth_credentials
+      )
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://slack.com/api',
+        Server::AUTH_SERVER => 'https://slack.com/oauth'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production'))
+      timeout = (ENV['TIMEOUT'] || 30).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      authorization_code_auth_credentials = AuthorizationCodeAuthCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        authorization_code_auth_credentials: authorization_code_auth_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/slack_web_api/controllers/admin_apps_approved_controller.rb

@@ -0,0 +1,48 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AdminAppsApprovedController
+  class AdminAppsApprovedController < BaseController
+    # List approved apps for an org or workspace.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.apps:read`
+    # @param [Integer] limit Optional parameter: The maximum number of items to
+    # return. Must be between 1 - 1000 both inclusive.
+    # @param [String] cursor Optional parameter: Set `cursor` to `next_cursor`
+    # returned by the previous call to list items in the next page
+    # @param [String] team_id Optional parameter: TODO: type description here
+    # @param [String] enterprise_id Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_apps_approved_list(token,
+                                 limit: nil,
+                                 cursor: nil,
+                                 team_id: nil,
+                                 enterprise_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/admin.apps.approved.list',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(token, key: 'token')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(team_id, key: 'team_id'))
+                   .query_param(new_parameter(enterprise_id, key: 'enterprise_id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DefaultSuccessTemplate.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 DefaultErrorTemplateException))
+        .execute
+    end
+  end
+end