Class: SlackWebApi::AdminTeamsSettingsController

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

Overview

AdminTeamsSettingsController

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_settings_info(token, team_id) ⇒ ApiResponse

Fetch information about settings in a workspace scope: admin.teams:read



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

def admin_teams_settings_info(token,
                              team_id)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/admin.teams.settings.info',
                                 Server::DEFAULT)
               .header_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'))
               .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

#admin_teams_settings_set_default_channels(token, team_id, channel_ids) ⇒ ApiResponse

Set the default channels of a workspace. scope: admin.teams:write the default channel for.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/slack_web_api/controllers/admin_teams_settings_controller.rb', line 44

def admin_teams_settings_set_default_channels(token,
                                              team_id,
                                              channel_ids)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/admin.teams.settings.setDefaultChannels',
                                 Server::DEFAULT)
               .form_param(new_parameter(token, key: 'token')
                            .is_required(true))
               .form_param(new_parameter(team_id, key: 'team_id')
                            .is_required(true))
               .form_param(new_parameter(channel_ids, key: 'channel_ids')
                            .is_required(true))
               .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(DefaultSuccessTemplate.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             DefaultErrorTemplateException))
    .execute
end

#admin_teams_settings_set_description(token, team_id, description) ⇒ ApiResponse

Set the description of a given workspace. scope: admin.teams:write the description for. the workspace.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/slack_web_api/controllers/admin_teams_settings_controller.rb', line 78

def admin_teams_settings_set_description(token,
                                         team_id,
                                         description)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/admin.teams.settings.setDescription',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .form_param(new_parameter(team_id, key: 'team_id')
                            .is_required(true))
               .form_param(new_parameter(description, key: 'description')
                            .is_required(true))
               .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(DefaultSuccessTemplate.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             DefaultErrorTemplateException))
    .execute
end

#admin_teams_settings_set_discoverability(token, team_id, discoverability) ⇒ ApiResponse

An API method that allows admins to set the discoverability of a given workspace scope: admin.teams:write discoverability on. discovery setting. It must be set to one of open, invite_only, closed, or unlisted.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/slack_web_api/controllers/admin_teams_settings_controller.rb', line 114

def admin_teams_settings_set_discoverability(token,
                                             team_id,
                                             discoverability)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/admin.teams.settings.setDiscoverability',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .form_param(new_parameter(team_id, key: 'team_id')
                            .is_required(true))
               .form_param(new_parameter(discoverability, key: 'discoverability')
                            .is_required(true))
               .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(DefaultSuccessTemplate.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             DefaultErrorTemplateException))
    .execute
end

#admin_teams_settings_set_icon(token, image_url, team_id) ⇒ ApiResponse

Sets the icon of a workspace. scope: admin.teams:write the icon for.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/slack_web_api/controllers/admin_teams_settings_controller.rb', line 147

def admin_teams_settings_set_icon(token,
                                  image_url,
                                  team_id)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/admin.teams.settings.setIcon',
                                 Server::DEFAULT)
               .form_param(new_parameter(token, key: 'token')
                            .is_required(true))
               .form_param(new_parameter(image_url, key: 'image_url')
                            .is_required(true))
               .form_param(new_parameter(team_id, key: 'team_id')
                            .is_required(true))
               .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(DefaultSuccessTemplate.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             DefaultErrorTemplateException))
    .execute
end

#admin_teams_settings_set_name(token, team_id, name) ⇒ ApiResponse

Set the name of a given workspace. scope: admin.teams:write the name for.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/slack_web_api/controllers/admin_teams_settings_controller.rb', line 180

def admin_teams_settings_set_name(token,
                                  team_id,
                                  name)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/admin.teams.settings.setName',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .form_param(new_parameter(team_id, key: 'team_id')
                            .is_required(true))
               .form_param(new_parameter(name, key: 'name')
                            .is_required(true))
               .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(DefaultSuccessTemplate.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             DefaultErrorTemplateException))
    .execute
end