slackapi-sdk 1.0.0

data/lib/slack_web_api/controllers/workflows_controller.rb

@@ -0,0 +1,130 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # WorkflowsController
+  class WorkflowsController < BaseController
+    # Indicate that an app's step in a workflow completed execution.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `workflow.steps:execute`
+    # @param [String] workflow_step_execute_id Required parameter: Context
+    # identifier that maps to the correct workflow step execution.
+    # @param [String] outputs Optional parameter: Key-value object of outputs
+    # from your step. Keys of this object reflect the configured `key`
+    # properties of your [`outputs`](/reference/workflows/workflow_step#output)
+    # array from your `workflow_step` object.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def workflows_step_completed(token,
+                                 workflow_step_execute_id,
+                                 outputs: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/workflows.stepCompleted',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .query_param(new_parameter(workflow_step_execute_id, key: 'workflow_step_execute_id')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
+                   .query_param(new_parameter(outputs, key: 'outputs'))
+                   .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
+
+    # Indicate that an app's step in a workflow failed to execute.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `workflow.steps:execute`
+    # @param [String] workflow_step_execute_id Required parameter: Context
+    # identifier that maps to the correct workflow step execution.
+    # @param [String] error Required parameter: A JSON-based object with a
+    # `message` property that should contain a human readable error message.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def workflows_step_failed(token,
+                              workflow_step_execute_id,
+                              error)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/workflows.stepFailed',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .query_param(new_parameter(workflow_step_execute_id, key: 'workflow_step_execute_id')
+                                 .is_required(true))
+                   .query_param(new_parameter(error, key: 'error')
+                                 .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
+
+    # Update the configuration for a workflow extension step.
+    # @param [String] token Required parameter: Authentication token. Requires
+    # scope: `workflow.steps:execute`
+    # @param [String] workflow_step_edit_id Required parameter: A context
+    # identifier provided with `view_submission` payloads used to call back to
+    # `workflows.updateStep`.
+    # @param [String] inputs Optional parameter: A JSON key-value map of inputs
+    # required from a user during configuration. This is the data your app
+    # expects to receive when the workflow step starts. **Please note**: the
+    # embedded variable format is set and replaced by the workflow system. You
+    # cannot create custom variables that will be replaced at runtime. [Read
+    # more about variables in workflow steps
+    # here](/workflows/steps#variables).
+    # @param [String] outputs Optional parameter: An JSON array of output
+    # objects used during step execution. This is the data your app agrees to
+    # provide when your workflow step was executed.
+    # @param [String] step_name Optional parameter: An optional field that can
+    # be used to override the step name that is shown in the Workflow Builder.
+    # @param [String] step_image_url Optional parameter: An optional field that
+    # can be used to override app image that is shown in the Workflow Builder.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def workflows_update_step(token,
+                              workflow_step_edit_id,
+                              inputs: nil,
+                              outputs: nil,
+                              step_name: nil,
+                              step_image_url: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/workflows.updateStep',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(token, key: 'token')
+                                  .is_required(true))
+                   .query_param(new_parameter(workflow_step_edit_id, key: 'workflow_step_edit_id')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
+                   .query_param(new_parameter(inputs, key: 'inputs'))
+                   .query_param(new_parameter(outputs, key: 'outputs'))
+                   .query_param(new_parameter(step_name, key: 'step_name'))
+                   .query_param(new_parameter(step_image_url, key: 'step_image_url'))
+                   .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/exceptions/admin_conversations_archive_error_schema_exception.rb

@@ -0,0 +1,50 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # Schema for error response from admin.conversations.archive
+  class AdminConversationsArchiveErrorSchemaException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Error]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :ok
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, ok: #{@ok}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, ok: #{@ok.inspect}>"
+    end
+  end
+end

data/lib/slack_web_api/exceptions/admin_conversations_convert_to_private_error_schema_exception.rb

@@ -0,0 +1,50 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # Schema for error response from admin.conversations.convertToPrivate
+  class AdminConversationsConvertToPrivateErrorSchemaException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Error1]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :ok
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, ok: #{@ok}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, ok: #{@ok.inspect}>"
+    end
+  end
+end

data/lib/slack_web_api/exceptions/admin_conversations_create_error_schema_exception.rb

@@ -0,0 +1,50 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # Schema for error response from admin.conversations.create
+  class AdminConversationsCreateErrorSchemaException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Error2]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :ok
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, ok: #{@ok}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, ok: #{@ok.inspect}>"
+    end
+  end
+end

data/lib/slack_web_api/exceptions/admin_conversations_delete_error_schema_exception.rb

@@ -0,0 +1,50 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # Schema for error response from admin.conversations.delete
+  class AdminConversationsDeleteErrorSchemaException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Error3]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :ok
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, ok: #{@ok}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, ok: #{@ok.inspect}>"
+    end
+  end
+end

data/lib/slack_web_api/exceptions/admin_conversations_disconnect_shared_error_schema_exception.rb

@@ -0,0 +1,50 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # Schema for error response from admin.conversations.disconnectShared
+  class AdminConversationsDisconnectSharedErrorSchemaException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Error4]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :ok
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, ok: #{@ok}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, ok: #{@ok.inspect}>"
+    end
+  end
+end

data/lib/slack_web_api/exceptions/admin_conversations_get_teams_error_schema_exception.rb

@@ -0,0 +1,50 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # Schema for error response from admin.conversations.getTeams
+  class AdminConversationsGetTeamsErrorSchemaException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Error6]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :ok
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, ok: #{@ok}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, ok: #{@ok.inspect}>"
+    end
+  end
+end

data/lib/slack_web_api/exceptions/admin_conversations_invite_error_schema_exception.rb

@@ -0,0 +1,50 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # Schema for error response from admin.conversations.invite
+  class AdminConversationsInviteErrorSchemaException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Error7]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :ok
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, ok: #{@ok}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, ok: #{@ok.inspect}>"
+    end
+  end
+end

data/lib/slack_web_api/exceptions/admin_conversations_search_error_schema_exception.rb

@@ -0,0 +1,50 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # Schema for error response from admin.conversations.search
+  class AdminConversationsSearchErrorSchemaException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Error9]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :ok
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, ok: #{@ok}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, ok: #{@ok.inspect}>"
+    end
+  end
+end

data/lib/slack_web_api/exceptions/admin_conversations_set_conversation_prefs_error_schema_exception.rb

@@ -0,0 +1,50 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # Schema for error response from admin.conversations.setConversationPrefs
+  class AdminConversationsSetConversationPrefsErrorSchemaException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Error10]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :ok
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, ok: #{@ok}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, ok: #{@ok.inspect}>"
+    end
+  end
+end

data/lib/slack_web_api/exceptions/admin_conversations_unarchive_error_schema2_exception.rb

@@ -0,0 +1,50 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # Schema for error response from admin.conversations.rename
+  class AdminConversationsUnarchiveErrorSchema2Exception < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Error8]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :ok
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, ok: #{@ok}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, ok: #{@ok.inspect}>"
+    end
+  end
+end

data/lib/slack_web_api/exceptions/admin_conversations_unarchive_error_schema3_exception.rb

@@ -0,0 +1,50 @@
+# slack_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SlackWebApi
+  # Schema for error response from admin.conversations.unarchive
+  class AdminConversationsUnarchiveErrorSchema3Exception < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Error11]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :ok
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, ok: #{@ok}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, ok: #{@ok.inspect}>"
+    end
+  end
+end