Class: SlackWebApi::UsergroupsController

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

Overview

UsergroupsController

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_create(token, name, channels: nil, description: nil, handle: nil, include_count: nil) ⇒ ApiResponse

Create a User Group scope: usergroups:write be unique among User Groups. encoded channel IDs for which the User Group uses as a default. User Group. unique among channels, users and User Groups. the number of users in each User Group.

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • name (String) —

    Required parameter: A name for the User Group. Must

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

    Optional parameter: A comma separated string of

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

    Optional parameter: A short description of the

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

    Optional parameter: A mention handle. Must be

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

    Optional parameter: Include

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/slack_web_api/controllers/usergroups_controller.rb', line 23

def usergroups_create(token,
                      name,
                      channels: nil,
                      description: nil,
                      handle: nil,
                      include_count: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/usergroups.create',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .form_param(new_parameter(name, key: 'name')
                            .is_required(true))
               .form_param(new_parameter(channels, key: 'channels'))
               .form_param(new_parameter(description, key: 'description'))
               .form_param(new_parameter(handle, key: 'handle'))
               .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(UsergroupsCreateSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             UsergroupsCreateErrorSchemaException))
    .execute
end

#usergroups_disable(token, usergroup, include_count: nil) ⇒ ApiResponse

Disable an existing User Group scope: usergroups:write Group to disable. 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

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

    Optional parameter: Include

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/slack_web_api/controllers/usergroups_controller.rb', line 62

def usergroups_disable(token,
                       usergroup,
                       include_count: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/usergroups.disable',
                                 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(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(UsergroupsDisableSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             UsergroupsDisableErrorSchemaException))
    .execute
end

#usergroups_enable(token, usergroup, include_count: nil) ⇒ ApiResponse

Enable a User Group scope: usergroups:write Group to enable. 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

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

    Optional parameter: Include

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/slack_web_api/controllers/usergroups_controller.rb', line 95

def usergroups_enable(token,
                      usergroup,
                      include_count: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/usergroups.enable',
                                 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(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(UsergroupsEnableSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             UsergroupsEnableErrorSchemaException))
    .execute
end

#usergroups_list(token, include_users: nil, include_count: nil, include_disabled: nil) ⇒ ApiResponse

List all User Groups for a team scope: usergroups:read the list of users for each User Group. the number of users in each User Group. Include disabled User Groups.

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

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

    Optional parameter: Include

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

    Optional parameter: Include

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

    Optional parameter:

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/slack_web_api/controllers/usergroups_controller.rb', line 130

def usergroups_list(token,
                    include_users: nil,
                    include_count: nil,
                    include_disabled: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/usergroups.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(include_users, key: 'include_users'))
               .query_param(new_parameter(include_count, key: 'include_count'))
               .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(UsergroupsListSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             UsergroupsListErrorSchemaException))
    .execute
end

#usergroups_update(token, usergroup, handle: nil, description: nil, channels: nil, include_count: nil, name: nil) ⇒ ApiResponse

Update an existing User Group scope: usergroups:write Group to update. unique among channels, users and User Groups. User Group. encoded channel IDs for which the User Group uses as a default. the number of users in the User Group. be unique among User Groups.

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • usergroup (String) —

    Required parameter: The encoded ID of the User

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

    Optional parameter: A mention handle. Must be

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

    Optional parameter: A short description of the

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

    Optional parameter: A comma separated string of

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

    Optional parameter: Include

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

    Optional parameter: A name for the User Group. Must

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/slack_web_api/controllers/usergroups_controller.rb', line 172

def usergroups_update(token,
                      usergroup,
                      handle: nil,
                      description: nil,
                      channels: nil,
                      include_count: nil,
                      name: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/usergroups.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(handle, key: 'handle'))
               .form_param(new_parameter(description, key: 'description'))
               .form_param(new_parameter(channels, key: 'channels'))
               .form_param(new_parameter(include_count, key: 'include_count'))
               .form_param(new_parameter(name, key: 'name'))
               .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(UsergroupsUpdateSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             UsergroupsUpdateErrorSchemaException))
    .execute
end