Class: SlackWebApi::AppsController

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

Overview

AppsController

Constant Summary

Constants inherited from BaseController

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

#apps_uninstall(token: nil, client_id: nil, client_secret: nil) ⇒ ApiResponse

Uninstalls your app from a workspace. scope: none application. your application.

Parameters:

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

    Optional parameter: Authentication token. Requires

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

    Optional parameter: Issued when you created your

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

    Optional parameter: Issued when you created

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/slack_web_api/controllers/apps_controller.rb', line 17

def apps_uninstall(token: nil,
                   client_id: nil,
                   client_secret: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/apps.uninstall',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
               .query_param(new_parameter(token, key: 'token'))
               .query_param(new_parameter(client_id, key: 'client_id'))
               .query_param(new_parameter(client_secret, key: 'client_secret'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('slackAuth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(AppsUninstallSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             AppsUninstallErrorSchemaException))
    .execute
end