ZCRMSDK 2.1.0 → 3.0.0.beta

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

@@ -0,0 +1,213 @@
+require_relative '../util/model'
+
+module Pipeline
+  class Pipeline
+    include Util::Model
+
+    # Creates an instance of Pipeline
+    def initialize
+      @from = nil
+      @to = nil
+      @parent = nil
+      @child_available = nil
+      @display_value = nil
+      @default = nil
+      @maps = nil
+      @actual_value = nil
+      @id = 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 get the parent
+      # @return An instance of Pipeline
+
+    def parent
+      @parent
+    end
+
+      # The method to set the value to parent
+      # @param parent [Pipeline] An instance of Pipeline
+
+    def parent=(parent)
+      if parent!=nil and !parent.is_a? Pipeline
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: parent EXPECTED TYPE: Pipeline', nil, nil)
+      end
+      @parent = parent
+      @key_modified['parent'] = 1
+    end
+
+      # The method to get the child_available
+      # @return A Boolean value
+
+    def child_available
+      @child_available
+    end
+
+      # The method to set the value to child_available
+      # @param child_available [Boolean] A Boolean
+
+    def child_available=(child_available)
+      if child_available!=nil and ! [true, false].include?child_available
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: child_available EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @child_available = child_available
+      @key_modified['child_available'] = 1
+    end
+
+      # The method to get the display_value
+      # @return A String value
+
+    def display_value
+      @display_value
+    end
+
+      # The method to set the value to display_value
+      # @param display_value [String] A String
+
+    def display_value=(display_value)
+      if display_value!=nil and !display_value.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: String', nil, nil)
+      end
+      @display_value = display_value
+      @key_modified['display_value'] = 1
+    end
+
+      # The method to get the default
+      # @return A Boolean value
+
+    def default
+      @default
+    end
+
+      # The method to set the value to default
+      # @param default [Boolean] A Boolean
+
+    def default=(default)
+      if default!=nil and ! [true, false].include?default
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @default = default
+      @key_modified['default'] = 1
+    end
+
+      # The method to get the maps
+      # @return An instance of Array
+
+    def maps
+      @maps
+    end
+
+      # The method to set the value to maps
+      # @param maps [Array] An instance of Array
+
+    def maps=(maps)
+      if maps!=nil and !maps.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: maps EXPECTED TYPE: Array', nil, nil)
+      end
+      @maps = maps
+      @key_modified['maps'] = 1
+    end
+
+      # The method to get the actual_value
+      # @return A String value
+
+    def actual_value
+      @actual_value
+    end
+
+      # The method to set the value to actual_value
+      # @param actual_value [String] A String
+
+    def actual_value=(actual_value)
+      if actual_value!=nil and !actual_value.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: String', nil, nil)
+      end
+      @actual_value = actual_value
+      @key_modified['actual_value'] = 1
+    end
+
+      # The method to get the id
+      # @return A Integer value
+
+    def id
+      @id
+    end
+
+      # The method to set the value to id
+      # @param id [Integer] A Integer
+
+    def id=(id)
+      if id!=nil and !id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+      end
+      @id = id
+      @key_modified['id'] = 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/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