Class: SlackWebApi::AdminTeamsAdminsController

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

Overview

AdminTeamsAdminsController

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

#admin_teams_admins_list(token, team_id, limit: nil, cursor: nil) ⇒ ApiResponse

List all of the admins on a given workspace. scope: admin.teams:read return. returned by the previous call to list items in the next page.

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • team_id (String) —

    Required parameter: TODO: type description here

  • limit (Integer) (defaults to: nil) —

    Optional parameter: The maximum number of items to

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

    Optional parameter: Set cursor to next_cursor

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



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

def admin_teams_admins_list(token,
                            team_id,
                            limit: nil,
                            cursor: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/admin.teams.admins.list',
                                 Server::DEFAULT)
               .query_param(new_parameter(token, key: 'token')
                             .is_required(true))
               .query_param(new_parameter(team_id, key: 'team_id')
                             .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'))
               .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