slackapi-sdk 1.0.0

data/lib/slack_web_api/controllers/apps_permissions_scopes_controller.rb

@@ -0,0 +1,33 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AppsPermissionsScopesController
+  class AppsPermissionsScopesController < BaseController
+    # Returns list of scopes this app has on a team.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `none`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def apps_permissions_scopes_list(token)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/apps.permissions.scopes.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'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ApiPermissionsScopesListSuccessSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 AppsPermissionsScopesListErrorSchemaException))
+        .execute
+    end
+  end
+end

data/lib/slack_web_api/controllers/apps_permissions_users_controller.rb

@@ -0,0 +1,85 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AppsPermissionsUsersController
+  class AppsPermissionsUsersController < BaseController
+    # Returns list of user grants and corresponding scopes this app has on a
+    # team.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `none`
+    # @param [String] cursor Optional parameter: 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](/docs/pagination) for more detail.
+    # @param [Integer] limit Optional parameter: The maximum number of items to
+    # return.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def apps_permissions_users_list(token,
+                                    cursor: nil,
+                                    limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/apps.permissions.users.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(cursor, key: 'cursor'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .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
+
+    # Enables an app to trigger a permissions modal to grant an app access to a
+    # user access scope.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `none`
+    # @param [String] scopes Required parameter: A comma separated list of user
+    # scopes to request for
+    # @param [String] trigger_id Required parameter: Token used to trigger the
+    # request
+    # @param [String] user Required parameter: The user this scope is being
+    # requested for
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def apps_permissions_users_request(token,
+                                       scopes,
+                                       trigger_id,
+                                       user)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/apps.permissions.users.request',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(token, key: 'token')
+                                 .is_required(true))
+                   .query_param(new_parameter(scopes, key: 'scopes')
+                                 .is_required(true))
+                   .query_param(new_parameter(trigger_id, key: 'trigger_id')
+                                 .is_required(true))
+                   .query_param(new_parameter(user, key: 'user')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
+                   .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',
+                                 'Standard failure response when trigger_id is invalid',
+                                 DefaultErrorTemplateException))
+        .execute
+    end
+  end
+end

data/lib/slack_web_api/controllers/auth_controller.rb

@@ -0,0 +1,62 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AuthController
+  class AuthController < BaseController
+    # Revokes a token.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `none`
+    # @param [TrueClass | FalseClass] test Optional parameter: Setting this
+    # parameter to `1` triggers a _testing mode_ where the specified token will
+    # not actually be revoked.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def auth_revoke(token,
+                    test: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/auth.revoke',
+                                     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(test, key: 'test'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AuthRevokeSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 AuthRevokeErrorSchemaException))
+        .execute
+    end
+
+    # Checks authentication & identity.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `none`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def auth_test(token)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/auth.test',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AuthTestSuccessSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Standard failure response when used with an invalid token',
+                                 AuthTestErrorSchemaException))
+        .execute
+    end
+  end
+end

data/lib/slack_web_api/controllers/base_controller.rb

@@ -0,0 +1,67 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # BaseController.
+  class BaseController
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/1.0.0 [OS: {os-info}, Engine: {engine}/{engine-version}]'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/slack_web_api/controllers/bots_controller.rb

@@ -0,0 +1,36 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # BotsController
+  class BotsController < BaseController
+    # Gets information about a bot user.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `users:read`
+    # @param [String] bot Optional parameter: Bot user to get info on
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bots_info(token,
+                  bot: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/bots.info',
+                                     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(bot, key: 'bot'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BotsInfoSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'When no bot can be found, it returns an error.',
+                                 BotsInfoErrorSchemaException))
+        .execute
+    end
+  end
+end

data/lib/slack_web_api/controllers/calls_controller.rb

@@ -0,0 +1,174 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # CallsController
+  class CallsController < BaseController
+    # Registers a new Call.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `calls:write`
+    # @param [String] external_unique_id Required parameter: An ID supplied by
+    # the 3rd-party Call provider. It must be unique across all Calls from that
+    # service.
+    # @param [String] join_url Required parameter: The URL required for a client
+    # to join the Call.
+    # @param [String] external_display_id Optional parameter: An optional,
+    # human-readable ID supplied by the 3rd-party Call provider. If supplied,
+    # this ID will be displayed in the Call object.
+    # @param [String] desktop_app_join_url Optional parameter: When supplied,
+    # available Slack clients will attempt to directly launch the 3rd-party Call
+    # with this URL.
+    # @param [Integer] date_start Optional parameter: Call start time in UTC
+    # UNIX timestamp format
+    # @param [String] title Optional parameter: The name of the Call.
+    # @param [String] created_by Optional parameter: 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.
+    # @param [String] users Optional parameter: The list of users to register as
+    # participants in the Call. [Read more on how to specify users
+    # here](/apis/calls#users).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def calls_add(token,
+                  external_unique_id,
+                  join_url,
+                  external_display_id: nil,
+                  desktop_app_join_url: nil,
+                  date_start: nil,
+                  title: nil,
+                  created_by: nil,
+                  users: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/calls.add',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(external_unique_id, key: 'external_unique_id')
+                                .is_required(true))
+                   .form_param(new_parameter(join_url, key: 'join_url')
+                                .is_required(true))
+                   .form_param(new_parameter(external_display_id, key: 'external_display_id'))
+                   .form_param(new_parameter(desktop_app_join_url, key: 'desktop_app_join_url'))
+                   .form_param(new_parameter(date_start, key: 'date_start'))
+                   .form_param(new_parameter(title, key: 'title'))
+                   .form_param(new_parameter(created_by, key: 'created_by'))
+                   .form_param(new_parameter(users, key: 'users'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .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
+
+    # Ends a Call.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `calls:write`
+    # @param [String] id Required parameter: `id` returned when registering the
+    # call using the [`calls.add`](/methods/calls.add) method.
+    # @param [Integer] duration Optional parameter: Call duration in seconds
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def calls_end(token,
+                  id,
+                  duration: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/calls.end',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(id, key: 'id')
+                                .is_required(true))
+                   .form_param(new_parameter(duration, key: 'duration'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .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
+
+    # Returns information about a Call.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `calls:read`
+    # @param [String] id Required parameter: `id` of the Call returned by the
+    # [`calls.add`](/methods/calls.add) method.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def calls_info(token,
+                   id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/calls.info',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .query_param(new_parameter(id, key: 'id')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
+                   .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
+
+    # Updates information about a Call.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `calls:write`
+    # @param [String] id Required parameter: `id` returned by the
+    # [`calls.add`](/methods/calls.add) method.
+    # @param [String] title Optional parameter: The name of the Call.
+    # @param [String] join_url Optional parameter: The URL required for a client
+    # to join the Call.
+    # @param [String] desktop_app_join_url Optional parameter: When supplied,
+    # available Slack clients will attempt to directly launch the 3rd-party Call
+    # with this URL.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def calls_update(token,
+                     id,
+                     title: nil,
+                     join_url: nil,
+                     desktop_app_join_url: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/calls.update',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(id, key: 'id')
+                                .is_required(true))
+                   .form_param(new_parameter(title, key: 'title'))
+                   .form_param(new_parameter(join_url, key: 'join_url'))
+                   .form_param(new_parameter(desktop_app_join_url, key: 'desktop_app_join_url'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .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

data/lib/slack_web_api/controllers/calls_participants_controller.rb

@@ -0,0 +1,79 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # CallsParticipantsController
+  class CallsParticipantsController < BaseController
+    # Registers new participants added to a Call.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `calls:write`
+    # @param [String] id Required parameter: `id` returned by the
+    # [`calls.add`](/methods/calls.add) method.
+    # @param [String] users Required parameter: The list of users to add as
+    # participants in the Call. [Read more on how to specify users
+    # here](/apis/calls#users).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def calls_participants_add(token,
+                               id,
+                               users)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/calls.participants.add',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(id, key: 'id')
+                                .is_required(true))
+                   .form_param(new_parameter(users, key: 'users')
+                                .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .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
+
+    # Registers participants removed from a Call.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `calls:write`
+    # @param [String] id Required parameter: `id` returned by the
+    # [`calls.add`](/methods/calls.add) method.
+    # @param [String] users Required parameter: The list of users to remove as
+    # participants in the Call. [Read more on how to specify users
+    # here](/apis/calls#users).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def calls_participants_remove(token,
+                                  id,
+                                  users)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/calls.participants.remove',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(id, key: 'id')
+                                .is_required(true))
+                   .form_param(new_parameter(users, key: 'users')
+                                .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .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