Class: SlackWebApi::UsergroupsUsersController

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

Overview

UsergroupsUsersController

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

#usergroups_users_list(token, usergroup, include_disabled: nil) ⇒ ApiResponse

List all users in a User Group scope: usergroups:read Group to update. results that involve disabled User Groups.

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • usergroup (String) —

    Required parameter: The encoded ID of the User

  • include_disabled (TrueClass | FalseClass) (defaults to: nil) —

    Optional parameter: Allow

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
39
40
 
# File 'lib/slack_web_api/controllers/usergroups_users_controller.rb', line 17

def usergroups_users_list(token,
                          usergroup,
                          include_disabled: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/usergroups.users.list',
                                 Server::DEFAULT)
               .query_param(new_parameter(token, key: 'token')
                             .is_required(true))
               .query_param(new_parameter(usergroup, key: 'usergroup')
                             .is_required(true))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
               .query_param(new_parameter(include_disabled, key: 'include_disabled'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('slackAuth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(UsergroupsUsersListSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Standard failure response when used with an invalid token',
                             UsergroupsUsersListErrorSchemaException))
    .execute
end

#usergroups_users_update(token, usergroup, users, include_count: nil) ⇒ ApiResponse

Update the list of users for a User Group scope: usergroups:write Group to update. encoded user IDs that represent the entire list of users for the User Group. the number of users in the User Group.

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • usergroup (String) —

    Required parameter: The encoded ID of the User

  • users (String) —

    Required parameter: A comma separated string of

  • include_count (TrueClass | FalseClass) (defaults to: nil) —

    Optional parameter: Include

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/slack_web_api/controllers/usergroups_users_controller.rb', line 53

def usergroups_users_update(token,
                            usergroup,
                            users,
                            include_count: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/usergroups.users.update',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .form_param(new_parameter(usergroup, key: 'usergroup')
                            .is_required(true))
               .form_param(new_parameter(users, key: 'users')
                            .is_required(true))
               .form_param(new_parameter(include_count, key: 'include_count'))
               .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(UsergroupsUsersUpdateSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             UsergroupsUsersUpdateErrorSchemaException))
    .execute
end