ZCRMSDK 2.0.0 → 3.0.0.beta

data/src/com/zoho/crm/api/record/price_book.rb

@@ -0,0 +1,31 @@
+require_relative '../record/record'
+require_relative '../util/model'
+
+module Record
+  class PriceBook < Record
+    include Util::Model
+
+    # Creates an instance of PriceBook
+    def initialize
+      super
+    end
+
+      # The method to get the name
+      # @return A String value
+
+    def name
+      get_key_value('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
+      add_key_value('name', name)
+    end
+
+  end
+end

data/src/com/zoho/crm/api/record/record_operations.rb

@@ -37,7 +37,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + id.to_s
@@ -46,7 +46,7 @@ module Record
       handler_instance.category_method = 'READ'
       handler_instance.param = param_instance
       handler_instance.header = header_instance
-      Util::Utility.get_fields(module_api_name)
+      Util::Utility.get_fields(module_api_name, handler_instance)
       handler_instance.module_api_name = module_api_name
       require_relative 'response_handler'
       handler_instance.api_call(ResponseHandler.name, 'application/json')
@@ -70,7 +70,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + id.to_s
@@ -79,7 +79,7 @@ module Record
       handler_instance.category_method = 'UPDATE'
       handler_instance.content_type = 'application/json'
       handler_instance.request = request
-      Util::Utility.get_fields(module_api_name)
+      Util::Utility.get_fields(module_api_name, handler_instance)
       handler_instance.module_api_name = module_api_name
       require_relative 'action_handler'
       handler_instance.api_call(ActionHandler.name, 'application/json')
@@ -103,7 +103,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + id.to_s
@@ -133,14 +133,14 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET
       handler_instance.category_method = 'READ'
       handler_instance.param = param_instance
       handler_instance.header = header_instance
-      Util::Utility.get_fields(module_api_name)
+      Util::Utility.get_fields(module_api_name, handler_instance)
       handler_instance.module_api_name = module_api_name
       require_relative 'response_handler'
       handler_instance.api_call(ResponseHandler.name, 'application/json')
@@ -160,7 +160,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_POST
@@ -168,7 +168,7 @@ module Record
       handler_instance.content_type = 'application/json'
       handler_instance.request = request
       handler_instance.mandatory_checker = true
-      Util::Utility.get_fields(module_api_name)
+      Util::Utility.get_fields(module_api_name, handler_instance)
       handler_instance.module_api_name = module_api_name
       require_relative 'action_handler'
       handler_instance.api_call(ActionHandler.name, 'application/json')
@@ -188,7 +188,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_PUT
@@ -196,7 +196,7 @@ module Record
       handler_instance.content_type = 'application/json'
       handler_instance.request = request
       handler_instance.mandatory_checker = true
-      Util::Utility.get_fields(module_api_name)
+      Util::Utility.get_fields(module_api_name, handler_instance)
       handler_instance.module_api_name = module_api_name
       require_relative 'action_handler'
       handler_instance.api_call(ActionHandler.name, 'application/json')
@@ -216,7 +216,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
@@ -240,7 +240,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/upsert'
       handler_instance.api_path = api_path
@@ -248,7 +248,7 @@ module Record
       handler_instance.category_method = 'ACTION'
       handler_instance.content_type = 'application/json'
       handler_instance.request = request
-      Util::Utility.get_fields(module_api_name)
+      Util::Utility.get_fields(module_api_name, handler_instance)
       handler_instance.module_api_name = module_api_name
       require_relative 'action_handler'
       handler_instance.api_call(ActionHandler.name, 'application/json')
@@ -272,7 +272,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/deleted'
       handler_instance.api_path = api_path
@@ -298,14 +298,14 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/search'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET
       handler_instance.category_method = 'READ'
       handler_instance.param = param_instance
-      Util::Utility.get_fields(module_api_name)
+      Util::Utility.get_fields(module_api_name, handler_instance)
       handler_instance.module_api_name = module_api_name
       require_relative 'response_handler'
       handler_instance.api_call(ResponseHandler.name, 'application/json')
@@ -325,7 +325,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/Leads/'
+      api_path = api_path + '/crm/v2.1/Leads/'
       api_path = api_path + id.to_s
       api_path = api_path + '/actions/convert'
       handler_instance.api_path = api_path
@@ -334,7 +334,7 @@ module Record
       handler_instance.content_type = 'application/json'
       handler_instance.request = request
       handler_instance.mandatory_checker = true
-      Util::Utility.get_fields("Deals")
+      Util::Utility.get_fields("Deals", handler_instance)
       require_relative 'convert_action_handler'
       handler_instance.api_call(ConvertActionHandler.name, 'application/json')
     end
@@ -353,7 +353,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + id.to_s
@@ -383,7 +383,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + id.to_s
@@ -394,7 +394,7 @@ module Record
       handler_instance.content_type = 'multipart/form-data'
       handler_instance.request = request
       handler_instance.mandatory_checker = true
-      Util::Utility.get_modules()
+      Util::Utility.verify_photo_support(module_api_name)
       require_relative 'file_handler'
       handler_instance.api_call(FileHandler.name, 'application/json')
     end
@@ -413,7 +413,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + id.to_s
@@ -439,7 +439,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/actions/mass_update'
       handler_instance.api_path = api_path
@@ -448,7 +448,7 @@ module Record
       handler_instance.content_type = 'application/json'
       handler_instance.request = request
       handler_instance.mandatory_checker = true
-      Util::Utility.get_fields(module_api_name)
+      Util::Utility.get_fields(module_api_name, handler_instance)
       handler_instance.module_api_name = module_api_name
       require_relative 'mass_update_action_handler'
       handler_instance.api_call(MassUpdateActionHandler.name, 'application/json')
@@ -468,7 +468,7 @@ module Record
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/actions/mass_update'
       handler_instance.api_path = api_path
@@ -479,6 +479,157 @@ module Record
       handler_instance.api_call(MassUpdateResponseHandler.name, 'application/json')
     end
 
+      # The method to assign territories to multiple records
+      # @param module_api_name [String] A String
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def assign_territories_to_multiple_records(module_api_name, request)
+      if !module_api_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', 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/'
+      api_path = api_path + module_api_name.to_s
+      api_path = api_path + '/actions/assign_territories'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_POST
+      handler_instance.category_method = 'UPDATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      handler_instance.mandatory_checker = true
+      Util::Utility.get_fields(module_api_name, handler_instance)
+      handler_instance.module_api_name = module_api_name
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+      # The method to assign territory to record
+      # @param module_api_name [String] A String
+      # @param id [Integer] A Integer
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def assign_territory_to_record(module_api_name, id, request)
+      if !module_api_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
+      end
+      if !id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: 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/'
+      api_path = api_path + module_api_name.to_s
+      api_path = api_path + '/'
+      api_path = api_path + id.to_s
+      api_path = api_path + '/actions/assign_territories'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_POST
+      handler_instance.category_method = 'UPDATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      Util::Utility.get_fields(module_api_name, handler_instance)
+      handler_instance.module_api_name = module_api_name
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+      # The method to remove territories from multiple records
+      # @param module_api_name [String] A String
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def remove_territories_from_multiple_records(module_api_name, request)
+      if !module_api_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', 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/'
+      api_path = api_path + module_api_name.to_s
+      api_path = api_path + '/actions/remove_territories'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_POST
+      handler_instance.category_method = 'UPDATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      handler_instance.mandatory_checker = true
+      Util::Utility.get_fields(module_api_name, handler_instance)
+      handler_instance.module_api_name = module_api_name
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+      # The method to remove territories from record
+      # @param module_api_name [String] A String
+      # @param id [Integer] A Integer
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def remove_territories_from_record(module_api_name, id, request)
+      if !module_api_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
+      end
+      if !id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: 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/'
+      api_path = api_path + module_api_name.to_s
+      api_path = api_path + '/'
+      api_path = api_path + id.to_s
+      api_path = api_path + '/actions/remove_territories'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_POST
+      handler_instance.category_method = 'UPDATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      Util::Utility.get_fields(module_api_name, handler_instance)
+      handler_instance.module_api_name = module_api_name
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+      # The method to record count
+      # @param module_api_name [String] A String
+      # @param param_instance [ParameterMap] An instance of ParameterMap
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def record_count(module_api_name, param_instance=nil)
+      if !module_api_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
+      end
+      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/'
+      api_path = api_path + module_api_name.to_s
+      api_path = api_path + '/actions/count'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_GET
+      handler_instance.category_method = 'READ'
+      handler_instance.param = param_instance
+      require_relative 'count_handler'
+      handler_instance.api_call(CountHandler.name, 'application/json')
+    end
+
     class GetRecordParam
       @@approved = Param.new('approved', 'com.zoho.crm.api.Record.GetRecordParam')
       def self.approved
@@ -673,5 +824,24 @@ module Record
       end
     end
 
+    class RecordCountParam
+      @@criteria = Param.new('criteria', 'com.zoho.crm.api.Record.RecordCountParam')
+      def self.criteria
+        @@criteria
+      end
+      @@email = Param.new('email', 'com.zoho.crm.api.Record.RecordCountParam')
+      def self.email
+        @@email
+      end
+      @@phone = Param.new('phone', 'com.zoho.crm.api.Record.RecordCountParam')
+      def self.phone
+        @@phone
+      end
+      @@word = Param.new('word', 'com.zoho.crm.api.Record.RecordCountParam')
+      def self.word
+        @@word
+      end
+    end
+
   end
 end

data/src/com/zoho/crm/api/record/tax.rb

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