slackapi-sdk 1.0.0

data/lib/slack_web_api/controllers/team_controller.rb

@@ -0,0 +1,148 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # TeamController
+  class TeamController < BaseController
+    # Gets the access logs for the current team.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin`
+    # @param [String] before Optional parameter: End of time range of logs to
+    # include in results (inclusive).
+    # @param [String] count Optional parameter: TODO: type description here
+    # @param [String] page Optional parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def team_access_logs(token,
+                         before: nil,
+                         count: nil,
+                         page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/team.accessLogs',
+                                     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(before, key: 'before'))
+                   .query_param(new_parameter(count, key: 'count'))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TeamAccessLogsSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'A workspace must be on a paid plan to use this method,'\
+                                  ' otherwise the `paid_only` error is thrown:',
+                                 TeamAccessLogsErrorSchemaException))
+        .execute
+    end
+
+    # Gets billable users information for the current team.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin`
+    # @param [String] user Optional parameter: A user to retrieve the billable
+    # information for. Defaults to all users.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def team_billable_info(token,
+                           user: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/team.billableInfo',
+                                     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(user, key: 'user'))
+                   .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
+
+    # Gets information about the current team.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `team:read`
+    # @param [String] team Optional parameter: Team to get info on, if omitted,
+    # will return information about the current team. Will only return team that
+    # the authenticated token is allowed to see through external shared
+    # channels
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def team_info(token,
+                  team: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/team.info',
+                                     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(team, key: 'team'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TeamInfoSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 TeamInfoErrorSchemaException))
+        .execute
+    end
+
+    # Gets the integration logs for the current team.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin`
+    # @param [String] app_id Optional parameter: Filter logs to this Slack app.
+    # Defaults to all logs.
+    # @param [String] change_type Optional parameter: Filter logs with this
+    # change type. Defaults to all logs.
+    # @param [String] count Optional parameter: TODO: type description here
+    # @param [String] page Optional parameter: TODO: type description here
+    # @param [String] service_id Optional parameter: Filter logs to this
+    # service. Defaults to all logs.
+    # @param [String] user Optional parameter: Filter logs generated by this
+    # user’s actions. Defaults to all logs.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def team_integration_logs(token,
+                              app_id: nil,
+                              change_type: nil,
+                              count: nil,
+                              page: nil,
+                              service_id: nil,
+                              user: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/team.integrationLogs',
+                                     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(app_id, key: 'app_id'))
+                   .query_param(new_parameter(change_type, key: 'change_type'))
+                   .query_param(new_parameter(count, key: 'count'))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(service_id, key: 'service_id'))
+                   .query_param(new_parameter(user, key: 'user'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TeamIntegrationLogsSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 TeamIntegrationLogsErrorSchemaException))
+        .execute
+    end
+  end
+end

data/lib/slack_web_api/controllers/team_profile_controller.rb

@@ -0,0 +1,36 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # TeamProfileController
+  class TeamProfileController < BaseController
+    # Retrieve a team's profile.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `users.profile:read`
+    # @param [String] visibility Optional parameter: Filter by visibility.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def team_profile_get(token,
+                         visibility: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/team.profile.get',
+                                     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(visibility, key: 'visibility'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TeamProfileGetSuccessSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 TeamProfileGetErrorSchemaException))
+        .execute
+    end
+  end
+end

data/lib/slack_web_api/controllers/usergroups_controller.rb

@@ -0,0 +1,205 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # UsergroupsController
+  class UsergroupsController < BaseController
+    # Create a User Group
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `usergroups:write`
+    # @param [String] name Required parameter: A name for the User Group. Must
+    # be unique among User Groups.
+    # @param [String] channels Optional parameter: A comma separated string of
+    # encoded channel IDs for which the User Group uses as a default.
+    # @param [String] description Optional parameter: A short description of the
+    # User Group.
+    # @param [String] handle Optional parameter: A mention handle. Must be
+    # unique among channels, users and User Groups.
+    # @param [TrueClass | FalseClass] include_count Optional parameter: Include
+    # the number of users in each User Group.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+
+    # Disable an existing User Group
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `usergroups:write`
+    # @param [String] usergroup Required parameter: The encoded ID of the User
+    # Group to disable.
+    # @param [TrueClass | FalseClass] include_count Optional parameter: Include
+    # the number of users in the User Group.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+
+    # Enable a User Group
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `usergroups:write`
+    # @param [String] usergroup Required parameter: The encoded ID of the User
+    # Group to enable.
+    # @param [TrueClass | FalseClass] include_count Optional parameter: Include
+    # the number of users in the User Group.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+
+    # List all User Groups for a team
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `usergroups:read`
+    # @param [TrueClass | FalseClass] include_users Optional parameter: Include
+    # the list of users for each User Group.
+    # @param [TrueClass | FalseClass] include_count Optional parameter: Include
+    # the number of users in each User Group.
+    # @param [TrueClass | FalseClass] include_disabled Optional parameter:
+    # Include disabled User Groups.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+
+    # Update an existing User Group
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `usergroups:write`
+    # @param [String] usergroup Required parameter: The encoded ID of the User
+    # Group to update.
+    # @param [String] handle Optional parameter: A mention handle. Must be
+    # unique among channels, users and User Groups.
+    # @param [String] description Optional parameter: A short description of the
+    # User Group.
+    # @param [String] channels Optional parameter: A comma separated string of
+    # encoded channel IDs for which the User Group uses as a default.
+    # @param [TrueClass | FalseClass] include_count Optional parameter: Include
+    # the number of users in the User Group.
+    # @param [String] name Optional parameter: A name for the User Group. Must
+    # be unique among User Groups.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+  end
+end

data/lib/slack_web_api/controllers/usergroups_users_controller.rb

@@ -0,0 +1,81 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # UsergroupsUsersController
+  class UsergroupsUsersController < BaseController
+    # List all users in a User Group
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `usergroups:read`
+    # @param [String] usergroup Required parameter: The encoded ID of the User
+    # Group to update.
+    # @param [TrueClass | FalseClass] include_disabled Optional parameter: Allow
+    # results that involve disabled User Groups.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+
+    # Update the list of users for a User Group
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `usergroups:write`
+    # @param [String] usergroup Required parameter: The encoded ID of the User
+    # Group to update.
+    # @param [String] users Required parameter: A comma separated string of
+    # encoded user IDs that represent the entire list of users for the User
+    # Group.
+    # @param [TrueClass | FalseClass] include_count Optional parameter: Include
+    # the number of users in the User Group.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    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
+  end
+end