slackapi-sdk 1.0.0

data/lib/slack_web_api/controllers/reactions_controller.rb

@@ -0,0 +1,182 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # ReactionsController
+  class ReactionsController < BaseController
+    # Adds a reaction to an item.
+    # @param [String] channel Required parameter: Channel where the message to
+    # add reaction to was posted.
+    # @param [String] name Required parameter: Reaction (emoji) name.
+    # @param [String] timestamp Required parameter: Timestamp of the message to
+    # add reaction to.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `reactions:write`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def reactions_add(channel,
+                      name,
+                      timestamp,
+                      token)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/reactions.add',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(channel, key: 'channel')
+                                .is_required(true))
+                   .form_param(new_parameter(name, key: 'name')
+                                .is_required(true))
+                   .form_param(new_parameter(timestamp, key: 'timestamp')
+                                .is_required(true))
+                   .header_param(new_parameter(token, key: 'token')
+                                  .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(ReactionsAddSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 ReactionsAddErrorSchemaException))
+        .execute
+    end
+
+    # Gets reactions for an item.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `reactions:read`
+    # @param [String] channel Optional parameter: Channel where the message to
+    # get reactions for was posted.
+    # @param [String] file Optional parameter: File to get reactions for.
+    # @param [String] file_comment Optional parameter: File comment to get
+    # reactions for.
+    # @param [TrueClass | FalseClass] full Optional parameter: If true always
+    # return the complete reaction list.
+    # @param [String] timestamp Optional parameter: Timestamp of the message to
+    # get reactions for.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def reactions_get(token,
+                      channel: nil,
+                      file: nil,
+                      file_comment: nil,
+                      full: nil,
+                      timestamp: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reactions.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(channel, key: 'channel'))
+                   .query_param(new_parameter(file, key: 'file'))
+                   .query_param(new_parameter(file_comment, key: 'file_comment'))
+                   .query_param(new_parameter(full, key: 'full'))
+                   .query_param(new_parameter(timestamp, key: 'timestamp'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 ReactionsGetErrorSchemaException))
+        .execute
+    end
+
+    # Lists reactions made by a user.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `reactions:read`
+    # @param [String] user Optional parameter: Show reactions made by this user.
+    # Defaults to the authed user.
+    # @param [TrueClass | FalseClass] full Optional parameter: If true always
+    # return the complete reaction list.
+    # @param [Integer] count Optional parameter: TODO: type description here
+    # @param [Integer] page Optional parameter: TODO: type description here
+    # @param [String] cursor Optional parameter: Parameter for pagination. Set
+    # `cursor` equal to the `next_cursor` attribute returned by the previous
+    # request's `response_metadata`. This parameter is optional, but pagination
+    # is mandatory: the default value simply fetches the first "page" of the
+    # collection. See [pagination](/docs/pagination) for more details.
+    # @param [Integer] limit Optional parameter: The maximum number of items to
+    # return. Fewer than the requested number of items may be returned, even if
+    # the end of the list hasn't been reached.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def reactions_list(token,
+                       user: nil,
+                       full: nil,
+                       count: nil,
+                       page: nil,
+                       cursor: nil,
+                       limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reactions.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(user, key: 'user'))
+                   .query_param(new_parameter(full, key: 'full'))
+                   .query_param(new_parameter(count, key: 'count'))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .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(ReactionsListSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 ReactionsListErrorSchemaException))
+        .execute
+    end
+
+    # Removes a reaction from an item.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `reactions:write`
+    # @param [String] name Required parameter: Reaction (emoji) name.
+    # @param [String] file Optional parameter: File to remove reaction from.
+    # @param [String] file_comment Optional parameter: File comment to remove
+    # reaction from.
+    # @param [String] channel Optional parameter: Channel where the message to
+    # remove reaction from was posted.
+    # @param [String] timestamp Optional parameter: Timestamp of the message to
+    # remove reaction from.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def reactions_remove(token,
+                         name,
+                         file: nil,
+                         file_comment: nil,
+                         channel: nil,
+                         timestamp: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/reactions.remove',
+                                     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(file, key: 'file'))
+                   .form_param(new_parameter(file_comment, key: 'file_comment'))
+                   .form_param(new_parameter(channel, key: 'channel'))
+                   .form_param(new_parameter(timestamp, key: 'timestamp'))
+                   .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(ReactionsRemoveSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 ReactionsRemoveErrorSchemaException))
+        .execute
+    end
+  end
+end

data/lib/slack_web_api/controllers/reminders_controller.rb

@@ -0,0 +1,151 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # RemindersController
+  class RemindersController < BaseController
+    # Creates a reminder.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `reminders:write`
+    # @param [String] text Required parameter: The content of the reminder
+    # @param [String] time Required parameter: When this reminder should happen:
+    # the Unix timestamp (up to five years from now), the number of seconds
+    # until the reminder (if within 24 hours), or a natural language description
+    # (Ex. "in 15 minutes," or "every Thursday")
+    # @param [String] user Optional parameter: The user who will receive the
+    # reminder. If no user is specified, the reminder will go to user who
+    # created it.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def reminders_add(token,
+                      text,
+                      time,
+                      user: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/reminders.add',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(text, key: 'text')
+                                .is_required(true))
+                   .form_param(new_parameter(time, key: 'time')
+                                .is_required(true))
+                   .form_param(new_parameter(user, key: 'user'))
+                   .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(RemindersAddSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 RemindersAddErrorSchemaException))
+        .execute
+    end
+
+    # Marks a reminder as complete.
+    # @param [String] token Optional parameter: Authentication token. Requires
+    # scope: `reminders:write`
+    # @param [String] reminder Optional parameter: The ID of the reminder to be
+    # marked as complete
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def reminders_complete(token: nil,
+                           reminder: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/reminders.complete',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token'))
+                   .form_param(new_parameter(reminder, key: 'reminder'))
+                   .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(RemindersCompleteSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 RemindersCompleteErrorSchemaException))
+        .execute
+    end
+
+    # Deletes a reminder.
+    # @param [String] token Optional parameter: Authentication token. Requires
+    # scope: `reminders:write`
+    # @param [String] reminder Optional parameter: The ID of the reminder
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def reminders_delete(token: nil,
+                         reminder: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/reminders.delete',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token'))
+                   .form_param(new_parameter(reminder, key: 'reminder'))
+                   .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(RemindersDeleteSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 RemindersDeleteErrorSchemaException))
+        .execute
+    end
+
+    # Gets information about a reminder.
+    # @param [String] token Optional parameter: Authentication token. Requires
+    # scope: `reminders:read`
+    # @param [String] reminder Optional parameter: The ID of the reminder
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def reminders_info(token: nil,
+                       reminder: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reminders.info',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
+                   .query_param(new_parameter(token, key: 'token'))
+                   .query_param(new_parameter(reminder, key: 'reminder'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(RemindersInfoSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 RemindersInfoErrorSchemaException))
+        .execute
+    end
+
+    # Lists all reminders created by or for a given user.
+    # @param [String] token Optional parameter: Authentication token. Requires
+    # scope: `reminders:read`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def reminders_list(token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/reminders.list',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
+                   .query_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(RemindersListSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 RemindersListErrorSchemaException))
+        .execute
+    end
+  end
+end

data/lib/slack_web_api/controllers/rtm_controller.rb

@@ -0,0 +1,44 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # RtmController
+  class RtmController < BaseController
+    # Starts a Real Time Messaging session.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `rtm:stream`
+    # @param [TrueClass | FalseClass] batch_presence_aware Optional parameter:
+    # Batch presence deliveries via subscription. Enabling changes the shape of
+    # `presence_change` events. See [batch
+    # presence](/docs/presence-and-status#batching).
+    # @param [TrueClass | FalseClass] presence_sub Optional parameter: Only
+    # deliver presence events when requested by subscription. See [presence
+    # subscriptions](/docs/presence-and-status#subscriptions).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def rtm_connect(token,
+                    batch_presence_aware: nil,
+                    presence_sub: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/rtm.connect',
+                                     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(batch_presence_aware, key: 'batch_presence_aware'))
+                   .query_param(new_parameter(presence_sub, key: 'presence_sub'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('slackAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(RtmConnectSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 RtmConnectErrorSchemaException))
+        .execute
+    end
+  end
+end

data/lib/slack_web_api/controllers/search_controller.rb

@@ -0,0 +1,56 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # SearchController
+  class SearchController < BaseController
+    # Searches for messages matching a query.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `search:read`
+    # @param [String] query Required parameter: Search query.
+    # @param [Integer] count Optional parameter: Pass the number of results you
+    # want per "page". Maximum of `100`.
+    # @param [TrueClass | FalseClass] highlight Optional parameter: Pass a value
+    # of `true` to enable query highlight markers (see below).
+    # @param [Integer] page Optional parameter: TODO: type description here
+    # @param [String] sort Optional parameter: Return matches sorted by either
+    # `score` or `timestamp`.
+    # @param [String] sort_dir Optional parameter: Change sort direction to
+    # ascending (`asc`) or descending (`desc`).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_messages(token,
+                        query,
+                        count: nil,
+                        highlight: nil,
+                        page: nil,
+                        sort: nil,
+                        sort_dir: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/search.messages',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(token, key: 'token')
+                                 .is_required(true))
+                   .query_param(new_parameter(query, key: 'query')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
+                   .query_param(new_parameter(count, key: 'count'))
+                   .query_param(new_parameter(highlight, key: 'highlight'))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(sort, key: 'sort'))
+                   .query_param(new_parameter(sort_dir, key: 'sort_dir'))
+                   .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/stars_controller.rb

@@ -0,0 +1,130 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # StarsController
+  class StarsController < BaseController
+    # Adds a star to an item.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `stars:write`
+    # @param [String] channel Optional parameter: Channel to add star to, or
+    # channel where the message to add star to was posted (used with
+    # `timestamp`).
+    # @param [String] file Optional parameter: File to add star to.
+    # @param [String] file_comment Optional parameter: File comment to add star
+    # to.
+    # @param [String] timestamp Optional parameter: Timestamp of the message to
+    # add star to.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def stars_add(token,
+                  channel: nil,
+                  file: nil,
+                  file_comment: nil,
+                  timestamp: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/stars.add',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(channel, key: 'channel'))
+                   .form_param(new_parameter(file, key: 'file'))
+                   .form_param(new_parameter(file_comment, key: 'file_comment'))
+                   .form_param(new_parameter(timestamp, key: 'timestamp'))
+                   .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(StarsAddSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 StarsAddErrorSchemaException))
+        .execute
+    end
+
+    # Lists stars for a user.
+    # @param [String] token Optional parameter: Authentication token. Requires
+    # scope: `stars:read`
+    # @param [String] count Optional parameter: TODO: type description here
+    # @param [String] page Optional parameter: TODO: type description here
+    # @param [String] cursor Optional parameter: Parameter for pagination. Set
+    # `cursor` equal to the `next_cursor` attribute returned by the previous
+    # request's `response_metadata`. This parameter is optional, but pagination
+    # is mandatory: the default value simply fetches the first "page" of the
+    # collection. See [pagination](/docs/pagination) for more details.
+    # @param [Integer] limit Optional parameter: The maximum number of items to
+    # return. Fewer than the requested number of items may be returned, even if
+    # the end of the list hasn't been reached.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def stars_list(token: nil,
+                   count: nil,
+                   page: nil,
+                   cursor: nil,
+                   limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/stars.list',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
+                   .query_param(new_parameter(token, key: 'token'))
+                   .query_param(new_parameter(count, key: 'count'))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .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(StarsListSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 StarsListErrorSchemaException))
+        .execute
+    end
+
+    # Removes a star from an item.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `stars:write`
+    # @param [String] channel Optional parameter: Channel to remove star from,
+    # or channel where the message to remove star from was posted (used with
+    # `timestamp`).
+    # @param [String] file Optional parameter: File to remove star from.
+    # @param [String] file_comment Optional parameter: File comment to remove
+    # star from.
+    # @param [String] timestamp Optional parameter: Timestamp of the message to
+    # remove star from.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def stars_remove(token,
+                     channel: nil,
+                     file: nil,
+                     file_comment: nil,
+                     timestamp: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/stars.remove',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .form_param(new_parameter(channel, key: 'channel'))
+                   .form_param(new_parameter(file, key: 'file'))
+                   .form_param(new_parameter(file_comment, key: 'file_comment'))
+                   .form_param(new_parameter(timestamp, key: 'timestamp'))
+                   .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(StarsRemoveSchema.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Typical error response',
+                                 StarsRemoveErrorSchemaException))
+        .execute
+    end
+  end
+end