ZCRMSDK 1.0.4 → 3.0.0

data/src/com/zoho/crm/api/pipeline/pipeline_operations.rb

@@ -0,0 +1,165 @@
+require_relative '../param'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module Pipeline
+  class PipelineOperations
+
+      # Creates an instance of PipelineOperations with the given parameters
+      # @param layout_id [Integer] A Integer
+    def initialize(layout_id=nil)
+      if layout_id!=nil and !layout_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: layout_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      @layout_id = layout_id
+    end
+
+      # The method to transfer and delete
+      # @param request [TransferAndDeleteWrapper] An instance of TransferAndDeleteWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def transfer_and_delete(request)
+      if request!=nil and !request.is_a? TransferAndDeleteWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: TransferAndDeleteWrapper', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2.1/settings/pipeline/actions/transfer'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_POST
+      handler_instance.category_method = 'CREATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      handler_instance.mandatory_checker = true
+      handler_instance.add_param(Param.new('layout_id', 'com.zoho.crm.api.Pipeline.TransferAndDeleteParam'), @layout_id)
+      require_relative 'transfer_action_handler'
+      handler_instance.api_call(TransferActionHandler.name, 'application/json')
+    end
+
+      # The method to get pipelines
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_pipelines
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2.1/settings/pipeline'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_GET
+      handler_instance.category_method = 'READ'
+      handler_instance.add_param(Param.new('layout_id', 'com.zoho.crm.api.Pipeline.GetPipelinesParam'), @layout_id)
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+      # The method to create pipelines
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def create_pipelines(request)
+      if request!=nil and !request.is_a? BodyWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2.1/settings/pipeline'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_POST
+      handler_instance.category_method = 'CREATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      handler_instance.mandatory_checker = true
+      handler_instance.add_param(Param.new('layout_id', 'com.zoho.crm.api.Pipeline.CreatePipelinesParam'), @layout_id)
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+      # The method to update pipelines
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def update_pipelines(request)
+      if request!=nil and !request.is_a? BodyWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2.1/settings/pipeline'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_PUT
+      handler_instance.category_method = 'UPDATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      handler_instance.mandatory_checker = true
+      handler_instance.add_param(Param.new('layout_id', 'com.zoho.crm.api.Pipeline.UpdatePipelinesParam'), @layout_id)
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+      # The method to get pipeline
+      # @param pipeline_id [Integer] A Integer
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_pipeline(pipeline_id)
+      if !pipeline_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pipeline_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2.1/settings/pipeline/'
+      api_path = api_path + pipeline_id.to_s
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_GET
+      handler_instance.category_method = 'READ'
+      handler_instance.add_param(Param.new('layout_id', 'com.zoho.crm.api.Pipeline.GetPipelineParam'), @layout_id)
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+      # The method to update pipeline
+      # @param pipeline_id [Integer] A Integer
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def update_pipeline(pipeline_id, request)
+      if !pipeline_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pipeline_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      if request!=nil and !request.is_a? BodyWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2.1/settings/pipeline/'
+      api_path = api_path + pipeline_id.to_s
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_PUT
+      handler_instance.category_method = 'UPDATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      handler_instance.add_param(Param.new('layout_id', 'com.zoho.crm.api.Pipeline.UpdatePipelineParam'), @layout_id)
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+    class TransferAndDeleteParam
+    end
+
+    class GetPipelinesParam
+    end
+
+    class CreatePipelinesParam
+    end
+
+    class UpdatePipelinesParam
+    end
+
+    class GetPipelineParam
+    end
+
+    class UpdatePipelineParam
+    end
+
+  end
+end

data/src/com/zoho/crm/api/pipeline/response_handler.rb

@@ -0,0 +1,10 @@
+module Pipeline
+  module ResponseHandler
+
+    # Creates an instance of ResponseHandler
+    def initialize
+    end
+
+
+  end
+end

data/src/com/zoho/crm/api/pipeline/response_wrapper.rb

@@ -0,0 +1,63 @@
+require_relative '../util/model'
+
+module Pipeline
+  require_relative 'response_handler'
+  class ResponseWrapper
+    include Util::Model
+    include ResponseHandler
+
+    # Creates an instance of ResponseWrapper
+    def initialize
+      @pipeline = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the pipeline
+      # @return An instance of Array
+
+    def pipeline
+      @pipeline
+    end
+
+      # The method to set the value to pipeline
+      # @param pipeline [Array] An instance of Array
+
+    def pipeline=(pipeline)
+      if pipeline!=nil and !pipeline.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: Array', nil, nil)
+      end
+      @pipeline = pipeline
+      @key_modified['pipeline'] = 1
+    end
+
+      # The method to check if the user has modified the given key
+      # @param key [String] A String
+      # @return A Integer value
+
+    def is_key_modified(key)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if @key_modified.key?(key)
+        return @key_modified[key]
+      end
+
+      nil
+    end
+
+      # The method to mark the given key as modified
+      # @param key [String] A String
+      # @param modification [Integer] A Integer
+
+    def set_key_modified(key, modification)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if modification!=nil and !modification.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+      end
+      @key_modified[key] = modification
+    end
+
+  end
+end

data/src/com/zoho/crm/api/pipeline/stage.rb

@@ -0,0 +1,80 @@
+require_relative '../util/model'
+
+module Pipeline
+  class Stage
+    include Util::Model
+
+    # Creates an instance of Stage
+    def initialize
+      @from = nil
+      @to = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the from
+      # @return A Integer value
+
+    def from
+      @from
+    end
+
+      # The method to set the value to from
+      # @param from [Integer] A Integer
+
+    def from=(from)
+      if from!=nil and !from.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: from EXPECTED TYPE: Integer', nil, nil)
+      end
+      @from = from
+      @key_modified['from'] = 1
+    end
+
+      # The method to get the to
+      # @return A Integer value
+
+    def to
+      @to
+    end
+
+      # The method to set the value to to
+      # @param to [Integer] A Integer
+
+    def to=(to)
+      if to!=nil and !to.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: Integer', nil, nil)
+      end
+      @to = to
+      @key_modified['to'] = 1
+    end
+
+      # The method to check if the user has modified the given key
+      # @param key [String] A String
+      # @return A Integer value
+
+    def is_key_modified(key)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if @key_modified.key?(key)
+        return @key_modified[key]
+      end
+
+      nil
+    end
+
+      # The method to mark the given key as modified
+      # @param key [String] A String
+      # @param modification [Integer] A Integer
+
+    def set_key_modified(key, modification)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if modification!=nil and !modification.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+      end
+      @key_modified[key] = modification
+    end
+
+  end
+end

data/src/com/zoho/crm/api/pipeline/success_response.rb

@@ -0,0 +1,123 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Pipeline
+  require_relative 'transfer_action_response'
+  require_relative 'action_response'
+  class SuccessResponse
+    include Util::Model
+    include TransferActionResponse
+    include ActionResponse
+
+    # Creates an instance of SuccessResponse
+    def initialize
+      @status = nil
+      @code = nil
+      @message = nil
+      @details = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the status
+      # @return An instance of Util::Choice
+
+    def status
+      @status
+    end
+
+      # The method to set the value to status
+      # @param status [Util::Choice] An instance of Util::Choice
+
+    def status=(status)
+      if status!=nil and !status.is_a? Util::Choice
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Util::Choice', nil, nil)
+      end
+      @status = status
+      @key_modified['status'] = 1
+    end
+
+      # The method to get the code
+      # @return An instance of Util::Choice
+
+    def code
+      @code
+    end
+
+      # The method to set the value to code
+      # @param code [Util::Choice] An instance of Util::Choice
+
+    def code=(code)
+      if code!=nil and !code.is_a? Util::Choice
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Util::Choice', nil, nil)
+      end
+      @code = code
+      @key_modified['code'] = 1
+    end
+
+      # The method to get the message
+      # @return An instance of Util::Choice
+
+    def message
+      @message
+    end
+
+      # The method to set the value to message
+      # @param message [Util::Choice] An instance of Util::Choice
+
+    def message=(message)
+      if message!=nil and !message.is_a? Util::Choice
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Util::Choice', nil, nil)
+      end
+      @message = message
+      @key_modified['message'] = 1
+    end
+
+      # The method to get the details
+      # @return An instance of Hash
+
+    def details
+      @details
+    end
+
+      # The method to set the value to details
+      # @param details [Hash] An instance of Hash
+
+    def details=(details)
+      if details!=nil and !details.is_a? Hash
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Hash', nil, nil)
+      end
+      @details = details
+      @key_modified['details'] = 1
+    end
+
+      # The method to check if the user has modified the given key
+      # @param key [String] A String
+      # @return A Integer value
+
+    def is_key_modified(key)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if @key_modified.key?(key)
+        return @key_modified[key]
+      end
+
+      nil
+    end
+
+      # The method to mark the given key as modified
+      # @param key [String] A String
+      # @param modification [Integer] A Integer
+
+    def set_key_modified(key, modification)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if modification!=nil and !modification.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+      end
+      @key_modified[key] = modification
+    end
+
+  end
+end

data/src/com/zoho/crm/api/pipeline/transfer_action_handler.rb

@@ -0,0 +1,10 @@
+module Pipeline
+  module TransferActionHandler
+
+    # Creates an instance of TransferActionHandler
+    def initialize
+    end
+
+
+  end
+end