Class: SlackWebApi::BotsController

Inherits:
BaseController show all
Defined in:
lib/slack_web_api/controllers/bots_controller.rb

Overview

BotsController

Constant Summary

Constants inherited from BaseController

SlackWebApi::BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent, user_agent_parameters

Constructor Details

This class inherits a constructor from SlackWebApi::BaseController

Instance Method Details

#bots_info(token, bot: nil) ⇒ ApiResponse

Gets information about a bot user. scope: users:read

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • bot (String) (defaults to: nil) —

    Optional parameter: Bot user to get info on

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/slack_web_api/controllers/bots_controller.rb', line 14

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