slackapi-sdk 1.0.0

data/lib/slack_web_api/controllers/admin_teams_controller.rb

@@ -0,0 +1,84 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AdminTeamsController
+  class AdminTeamsController < BaseController
+    # Create an Enterprise team.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:write`
+    # @param [String] team_domain Required parameter: Team domain (for example,
+    # slacksoftballteam).
+    # @param [String] team_name Required parameter: Team name (for example,
+    # Slack Softball Team).
+    # @param [String] team_description Optional parameter: Description for the
+    # team.
+    # @param [String] team_discoverability Optional parameter: Who can join the
+    # team. A team's discoverability can be `open`, `closed`, `invite_only`, or
+    # `unlisted`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_teams_create(token,
+                           team_domain,
+                           team_name,
+                           team_description: nil,
+                           team_discoverability: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/admin.teams.create',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(team_domain, key: 'team_domain')
+                                .is_required(true))
+                   .form_param(new_parameter(team_name, key: 'team_name')
+                                .is_required(true))
+                   .form_param(new_parameter(team_description, key: 'team_description'))
+                   .form_param(new_parameter(team_discoverability, key: 'team_discoverability'))
+                   .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
+
+    # List all teams on an Enterprise organization
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:read`
+    # @param [Integer] limit Optional parameter: The maximum number of items to
+    # return. Must be between 1 - 100 both inclusive.
+    # @param [String] cursor Optional parameter: Set `cursor` to `next_cursor`
+    # returned by the previous call to list items in the next page.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_teams_list(token,
+                         limit: nil,
+                         cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/admin.teams.list',
+                                     Server::DEFAULT)
+                   .header_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(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
+  end
+end

data/lib/slack_web_api/controllers/admin_teams_owners_controller.rb

@@ -0,0 +1,45 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AdminTeamsOwnersController
+  class AdminTeamsOwnersController < BaseController
+    # List all of the owners on a given workspace.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:read`
+    # @param [String] team_id Required parameter: TODO: type description here
+    # @param [Integer] limit Optional parameter: The maximum number of items to
+    # return. Must be between 1 - 1000 both inclusive.
+    # @param [String] cursor Optional parameter: Set `cursor` to `next_cursor`
+    # returned by the previous call to list items in the next page.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_teams_owners_list(token,
+                                team_id,
+                                limit: nil,
+                                cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/admin.teams.owners.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
+  end
+end

data/lib/slack_web_api/controllers/admin_teams_settings_controller.rb

@@ -0,0 +1,206 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AdminTeamsSettingsController
+  class AdminTeamsSettingsController < BaseController
+    # Fetch information about settings in a workspace
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:read`
+    # @param [String] team_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+
+    # Set the default channels of a workspace.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:write`
+    # @param [String] team_id Required parameter: ID for the workspace to set
+    # the default channel for.
+    # @param [String] channel_ids Required parameter: An array of channel IDs.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+
+    # Set the description of a given workspace.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:write`
+    # @param [String] team_id Required parameter: ID for the workspace to set
+    # the description for.
+    # @param [String] description Required parameter: The new description for
+    # the workspace.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+
+    # An API method that allows admins to set the discoverability of a given
+    # workspace
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:write`
+    # @param [String] team_id Required parameter: The ID of the workspace to set
+    # discoverability on.
+    # @param [String] discoverability Required parameter: This workspace's
+    # discovery setting. It must be set to one of `open`, `invite_only`,
+    # `closed`, or `unlisted`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+
+    # Sets the icon of a workspace.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:write`
+    # @param [String] image_url Required parameter: Image URL for the icon
+    # @param [String] team_id Required parameter: ID for the workspace to set
+    # the icon for.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+
+    # Set the name of a given workspace.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:write`
+    # @param [String] team_id Required parameter: ID for the workspace to set
+    # the name for.
+    # @param [String] name Required parameter: The new name of the workspace.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+  end
+end

data/lib/slack_web_api/controllers/admin_usergroups_controller.rb

@@ -0,0 +1,161 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AdminUsergroupsController
+  class AdminUsergroupsController < BaseController
+    # Add one or more default channels to an IDP group.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.usergroups:write`
+    # @param [String] usergroup_id Required parameter: ID of the IDP group to
+    # add default channels for.
+    # @param [String] channel_ids Required parameter: Comma separated string of
+    # channel IDs.
+    # @param [String] team_id Optional parameter: The workspace to add default
+    # channels in.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_usergroups_add_channels(token,
+                                      usergroup_id,
+                                      channel_ids,
+                                      team_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/admin.usergroups.addChannels',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(usergroup_id, key: 'usergroup_id')
+                                .is_required(true))
+                   .form_param(new_parameter(channel_ids, key: 'channel_ids')
+                                .is_required(true))
+                   .form_param(new_parameter(team_id, key: 'team_id'))
+                   .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 if the token provided is not associated'\
+                                  ' with an Org Admin or Owner',
+                                 DefaultErrorTemplateException))
+        .execute
+    end
+
+    # Associate one or more default workspaces with an organization-wide IDP
+    # group.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:write`
+    # @param [String] usergroup_id Required parameter: An encoded usergroup (IDP
+    # Group) ID.
+    # @param [String] team_ids Required parameter: A comma separated list of
+    # encoded team (workspace) IDs. Each workspace *MUST* belong to the
+    # organization associated with the token.
+    # @param [TrueClass | FalseClass] auto_provision Optional parameter: When
+    # `true`, this method automatically creates new workspace accounts for the
+    # IDP group members.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_usergroups_add_teams(token,
+                                   usergroup_id,
+                                   team_ids,
+                                   auto_provision: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/admin.usergroups.addTeams',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(usergroup_id, key: 'usergroup_id')
+                                .is_required(true))
+                   .form_param(new_parameter(team_ids, key: 'team_ids')
+                                .is_required(true))
+                   .form_param(new_parameter(auto_provision, key: 'auto_provision'))
+                   .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
+
+    # List the channels linked to an org-level IDP group (user group).
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.usergroups:read`
+    # @param [String] usergroup_id Required parameter: ID of the IDP group to
+    # list default channels for.
+    # @param [String] team_id Optional parameter: ID of the the workspace.
+    # @param [TrueClass | FalseClass] include_num_members Optional parameter:
+    # Flag to include or exclude the count of members per channel.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_usergroups_list_channels(token,
+                                       usergroup_id,
+                                       team_id: nil,
+                                       include_num_members: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/admin.usergroups.listChannels',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .query_param(new_parameter(usergroup_id, key: 'usergroup_id')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
+                   .query_param(new_parameter(team_id, key: 'team_id'))
+                   .query_param(new_parameter(include_num_members, key: 'include_num_members'))
+                   .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 if the token provided is not associated'\
+                                  ' with an Org Admin or Owner',
+                                 DefaultErrorTemplateException))
+        .execute
+    end
+
+    # Remove one or more default channels from an org-level IDP group (user
+    # group).
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.usergroups:write`
+    # @param [String] usergroup_id Required parameter: ID of the IDP Group
+    # @param [String] channel_ids Required parameter: Comma-separated string of
+    # channel IDs
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_usergroups_remove_channels(token,
+                                         usergroup_id,
+                                         channel_ids)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/admin.usergroups.removeChannels',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(usergroup_id, key: 'usergroup_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 if the token provided is not associated'\
+                                  ' with an Org Admin or Owner',
+                                 DefaultErrorTemplateException))
+        .execute
+    end
+  end
+end