slack-apimatic-sdk 1.0.0

data/lib/slack_web_api/apis/admin_emoji_api.rb

@@ -0,0 +1,175 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AdminEmojiApi
+  class AdminEmojiApi < BaseApi
+    # Add an emoji.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:write`
+    # @param [String] name Required parameter: The name of the emoji to be
+    # removed. Colons (`:myemoji:`) around the value are not required, although
+    # they may be included.
+    # @param [String] url Required parameter: The URL of a file to use as an
+    # image for the emoji. Square images under 128KB and with transparent
+    # backgrounds work best.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_emoji_add(token,
+                        name,
+                        url)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/admin.emoji.add',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(token, key: 'token')
+                                .is_required(true))
+                   .form_param(new_parameter(name, key: 'name')
+                                .is_required(true))
+                   .form_param(new_parameter(url, key: 'url')
+                                .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
+
+    # Add an emoji alias.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:write`
+    # @param [String] name Required parameter: The name of the emoji to be
+    # aliased. Colons (`:myemoji:`) around the value are not required, although
+    # they may be included.
+    # @param [String] alias_for Required parameter: The alias of the emoji.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_emoji_add_alias(token,
+                              name,
+                              alias_for)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/admin.emoji.addAlias',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(token, key: 'token')
+                                .is_required(true))
+                   .form_param(new_parameter(name, key: 'name')
+                                .is_required(true))
+                   .form_param(new_parameter(alias_for, key: 'alias_for')
+                                .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
+
+    # List emoji for an Enterprise Grid organization.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:read`
+    # @param [String] cursor Optional parameter: Set `cursor` to `next_cursor`
+    # returned by the previous call to list items in the next page
+    # @param [Integer] limit Optional parameter: The maximum number of items to
+    # return. Must be between 1 - 1000 both inclusive.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_emoji_list(token,
+                         cursor: nil,
+                         limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/admin.emoji.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(cursor, key: 'cursor'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .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
+
+    # Remove an emoji across an Enterprise Grid organization
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:write`
+    # @param [String] name Required parameter: The name of the emoji to be
+    # removed. Colons (`:myemoji:`) around the value are not required, although
+    # they may be included.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_emoji_remove(token,
+                           name)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/admin.emoji.remove',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(token, key: 'token')
+                                .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
+
+    # Rename an emoji.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.teams:write`
+    # @param [String] name Required parameter: The name of the emoji to be
+    # renamed. Colons (`:myemoji:`) around the value are not required, although
+    # they may be included.
+    # @param [String] new_name Required parameter: The new name of the emoji.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_emoji_rename(token,
+                           name,
+                           new_name)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/admin.emoji.rename',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(token, key: 'token')
+                                .is_required(true))
+                   .form_param(new_parameter(name, key: 'name')
+                                .is_required(true))
+                   .form_param(new_parameter(new_name, key: 'new_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/apis/admin_invite_requests_api.rb

@@ -0,0 +1,112 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AdminInviteRequestsApi
+  class AdminInviteRequestsApi < BaseApi
+    # Approve a workspace invite request.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.invites:write`
+    # @param [String] invite_request_id Required parameter: ID of the request to
+    # invite.
+    # @param [String] team_id Optional parameter: ID for the workspace where the
+    # invite request was made.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_invite_requests_approve(token,
+                                      invite_request_id,
+                                      team_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/admin.inviteRequests.approve',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(invite_request_id, key: 'invite_request_id')
+                                .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',
+                                 DefaultErrorTemplateException))
+        .execute
+    end
+
+    # Deny a workspace invite request.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.invites:write`
+    # @param [String] invite_request_id Required parameter: ID of the request to
+    # invite.
+    # @param [String] team_id Optional parameter: ID for the workspace where the
+    # invite request was made.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_invite_requests_deny(token,
+                                   invite_request_id,
+                                   team_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/admin.inviteRequests.deny',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(invite_request_id, key: 'invite_request_id')
+                                .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',
+                                 DefaultErrorTemplateException))
+        .execute
+    end
+
+    # List all pending workspace invite requests.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.invites:read`
+    # @param [String] team_id Optional parameter: ID for the workspace where the
+    # invite requests were made.
+    # @param [String] cursor Optional parameter: Value of the `next_cursor`
+    # field sent as part of the previous API response
+    # @param [Integer] limit Optional parameter: The number of results that will
+    # be returned by the API on each invocation. Must be between 1 - 1000, both
+    # inclusive
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_invite_requests_list(token,
+                                   team_id: nil,
+                                   cursor: nil,
+                                   limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/admin.inviteRequests.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(team_id, key: 'team_id'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .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/apis/admin_invite_requests_approved_api.rb

@@ -0,0 +1,46 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AdminInviteRequestsApprovedApi
+  class AdminInviteRequestsApprovedApi < BaseApi
+    # List all approved workspace invite requests.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.invites:read`
+    # @param [String] team_id Optional parameter: ID for the workspace where the
+    # invite requests were made.
+    # @param [String] cursor Optional parameter: Value of the `next_cursor`
+    # field sent as part of the previous API response
+    # @param [Integer] limit Optional parameter: The number of results that will
+    # be returned by the API on each invocation. Must be between 1 - 1000, both
+    # inclusive
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_invite_requests_approved_list(token,
+                                            team_id: nil,
+                                            cursor: nil,
+                                            limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/admin.inviteRequests.approved.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(team_id, key: 'team_id'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .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/apis/admin_invite_requests_denied_api.rb

@@ -0,0 +1,46 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AdminInviteRequestsDeniedApi
+  class AdminInviteRequestsDeniedApi < BaseApi
+    # List all denied workspace invite requests.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `admin.invites:read`
+    # @param [String] team_id Optional parameter: ID for the workspace where the
+    # invite requests were made.
+    # @param [String] cursor Optional parameter: Value of the `next_cursor`
+    # field sent as part of the previous api response
+    # @param [Integer] limit Optional parameter: The number of results that will
+    # be returned by the API on each invocation. Must be between 1 - 1000 both
+    # inclusive
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def admin_invite_requests_denied_list(token,
+                                          team_id: nil,
+                                          cursor: nil,
+                                          limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/admin.inviteRequests.denied.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(team_id, key: 'team_id'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .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/apis/admin_teams_admins_api.rb

@@ -0,0 +1,45 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AdminTeamsAdminsApi
+  class AdminTeamsAdminsApi < BaseApi
+    # List all of the admins 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.
+    # @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_admins_list(token,
+                                team_id,
+                                limit: nil,
+                                cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/admin.teams.admins.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/apis/admin_teams_api.rb

@@ -0,0 +1,84 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AdminTeamsApi
+  class AdminTeamsApi < BaseApi
+    # 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/apis/admin_teams_owners_api.rb

@@ -0,0 +1,45 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # AdminTeamsOwnersApi
+  class AdminTeamsOwnersApi < BaseApi
+    # 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