ZCRMSDK 1.0.4 → 3.0.0

data/src/com/zoho/crm/api/fields/fields_operations.rb

@@ -0,0 +1,71 @@
+require_relative '../param'
+require_relative '../parameter_map'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module Fields
+  class FieldsOperations
+
+      # Creates an instance of FieldsOperations with the given parameters
+      # @param module_1 [String] A String
+    def initialize(module_1=nil)
+      if module_1!=nil and !module_1.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
+      end
+      @module_1 = module_1
+    end
+
+      # The method to get fields
+      # @param param_instance [ParameterMap] An instance of ParameterMap
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_fields(param_instance=nil)
+      if param_instance!=nil and !param_instance.is_a? ParameterMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2.1/settings/fields'
+      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('module', 'com.zoho.crm.api.Fields.GetFieldsParam'), @module_1)
+      handler_instance.param = param_instance
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+      # The method to get field
+      # @param id [Integer] A Integer
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_field(id)
+      if !id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2.1/settings/fields/'
+      api_path = api_path + 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('module', 'com.zoho.crm.api.Fields.GetFieldParam'), @module_1)
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+    class GetFieldsParam
+      @@type = Param.new('type', 'com.zoho.crm.api.Fields.GetFieldsParam')
+      def self.type
+        @@type
+      end
+    end
+
+    class GetFieldParam
+    end
+
+  end
+end

data/src/com/zoho/crm/api/fields/formula.rb

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

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

@@ -0,0 +1,80 @@
+require_relative '../util/model'
+
+module Fields
+  class LookupField
+    include Util::Model
+
+    # Creates an instance of LookupField
+    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/fields/maps.rb

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

@@ -0,0 +1,157 @@
+require_relative '../layouts/layout'
+require_relative '../util/model'
+
+module Fields
+  class Module
+    include Util::Model
+
+    # Creates an instance of Module
+    def initialize
+      @layout = nil
+      @display_label = nil
+      @api_name = nil
+      @module_1 = nil
+      @id = nil
+      @module_name = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the layout
+      # @return An instance of Layouts::Layout
+
+    def layout
+      @layout
+    end
+
+      # The method to set the value to layout
+      # @param layout [Layouts::Layout] An instance of Layouts::Layout
+
+    def layout=(layout)
+      if layout!=nil and !layout.is_a? Layouts::Layout
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', nil, nil)
+      end
+      @layout = layout
+      @key_modified['layout'] = 1
+    end
+
+      # The method to get the display_label
+      # @return A String value
+
+    def display_label
+      @display_label
+    end
+
+      # The method to set the value to display_label
+      # @param display_label [String] A String
+
+    def display_label=(display_label)
+      if display_label!=nil and !display_label.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
+      end
+      @display_label = display_label
+      @key_modified['display_label'] = 1
+    end
+
+      # The method to get the api_name
+      # @return A String value
+
+    def api_name
+      @api_name
+    end
+
+      # The method to set the value to api_name
+      # @param api_name [String] A String
+
+    def api_name=(api_name)
+      if api_name!=nil and !api_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: String', nil, nil)
+      end
+      @api_name = api_name
+      @key_modified['api_name'] = 1
+    end
+
+      # The method to get the module
+      # @return A String value
+
+    def module
+      @module_1
+    end
+
+      # The method to set the value to module
+      # @param module_1 [String] A String
+
+    def module=(module_1)
+      if module_1!=nil and !module_1.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
+      end
+      @module_1 = module_1
+      @key_modified['module'] = 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 module_name
+      # @return A String value
+
+    def module_name
+      @module_name
+    end
+
+      # The method to set the value to module_name
+      # @param module_name [String] A String
+
+    def module_name=(module_name)
+      if module_name!=nil and !module_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: String', nil, nil)
+      end
+      @module_name = module_name
+      @key_modified['module_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