ZCRMSDK 1.0.4 → 3.0.0

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

@@ -0,0 +1,61 @@
+require_relative '../util/model'
+
+module Pipeline
+  class BodyWrapper
+    include Util::Model
+
+    # Creates an instance of BodyWrapper
+    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/forecast_category.rb

@@ -0,0 +1,80 @@
+require_relative '../util/model'
+
+module Pipeline
+  class ForecastCategory
+    include Util::Model
+
+    # Creates an instance of ForecastCategory
+    def initialize
+      @id = nil
+      @name = nil
+      @key_modified = Hash.new
+    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 get the name
+      # @return A String value
+
+    def name
+      @name
+    end
+
+      # The method to set the value to name
+      # @param name [String] A String
+
+    def name=(name)
+      if name!=nil and !name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
+      end
+      @name = name
+      @key_modified['name'] = 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/pick_list_value.rb

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