ZCRMSDK 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a38c39eb99cb58ada6a20fbd961d0ba4437c69ce8d3fbbafb247cc896282a92
-  data.tar.gz: c30037cc4b76ac7515e47a94284f19bea6913254ba07e370217518e8e2139e80
+  metadata.gz: 4754097d74e87ebd8d343c0667ba59a07c2ad8b91e60f93dfbcac3ac05bd7391
+  data.tar.gz: 9528461fca077395fe305ea54af17b06275ebcfa00cfb052f1414eb27df3cd9b
 SHA512:
-  metadata.gz: 18c11a8ddaca2c07259aa42ad6a7f3c98de99fc349e602d19e1a69639c71c5689cd595362dec568858ceed6c96e3228a1b93a96ee08c8dd197a85a3553b9b721
-  data.tar.gz: a4ad7f6c41faa4180d75f280d2acf7a69bfa519dfb9f832503dc4692437fdcd4ef367edaafcd5044c24f7f0119dca3855b856cf7e3113cd4bbb1efec05d26b0a
+  metadata.gz: 434c2b3a036e8c48f334cfefb23d45307331cf508d284a56b05ad40d856cd20661c69f126624d2fa040be43dd383ad30c5526b195ecfadddb210878f1fc15d90
+  data.tar.gz: d6ed7370f2a3ce9ff9b3654ee35368daed99212397bafe772a0edeb43c8f2a5abb711fbc060839cb28a2c75a2a23d8fc514ad23e34dce5bdb9cb52c2440b38ce

data/src/com/zoho/api/logger/sdk_logger.rb

@@ -50,7 +50,6 @@ module SDKLog
     end
 
     def self.severe(message, exception = nil)
-     
       message = message + exception.to_s + exception.backtrace.join("\n") unless exception.nil?
       @@logger&.fatal(Time.new.to_s + ' ' + message)
     end

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

@@ -80,7 +80,7 @@ class Initializer
     end
 
     log = SDKLog::Log.initialize(Levels::INFO, File.join(Dir.pwd, Constants::LOGFILE_NAME)) if log.nil? 
-    
+
     SDKLog::SDKLogger.initialize(log)
 
     @@initializer = Initializer.new

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

@@ -56,9 +56,10 @@ module Record
       # @param id [Integer] A Integer
       # @param module_api_name [String] A String
       # @param request [BodyWrapper] An instance of BodyWrapper
+      # @param header_instance [HeaderMap] An instance of HeaderMap
       # @return An instance of APIResponse
     # @raise SDKException
-    def update_record(id, module_api_name, request)
+    def update_record(id, module_api_name, request, header_instance=nil)
       if !id.is_a? Integer
         raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
       end
@@ -68,6 +69,9 @@ module Record
       if request!=nil and !request.is_a? BodyWrapper
         raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
       end
+      if header_instance!=nil and !header_instance.is_a? HeaderMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
+      end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
       api_path = api_path + '/crm/v2/'
@@ -79,6 +83,7 @@ module Record
       handler_instance.category_method = 'UPDATE'
       handler_instance.content_type = 'application/json'
       handler_instance.request = request
+      handler_instance.header = header_instance
       Util::Utility.get_fields(module_api_name)
       handler_instance.module_api_name = module_api_name
       require_relative 'action_handler'
@@ -89,9 +94,10 @@ module Record
       # @param id [Integer] A Integer
       # @param module_api_name [String] A String
       # @param param_instance [ParameterMap] An instance of ParameterMap
+      # @param header_instance [HeaderMap] An instance of HeaderMap
       # @return An instance of APIResponse
     # @raise SDKException
-    def delete_record(id, module_api_name, param_instance=nil)
+    def delete_record(id, module_api_name, param_instance=nil, header_instance=nil)
       if !id.is_a? Integer
         raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
       end
@@ -101,6 +107,9 @@ module Record
       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
+      if header_instance!=nil and !header_instance.is_a? HeaderMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
+      end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
       api_path = api_path + '/crm/v2/'
@@ -111,6 +120,7 @@ module Record
       handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
       handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
       handler_instance.param = param_instance
+      handler_instance.header = header_instance
       require_relative 'action_handler'
       handler_instance.api_call(ActionHandler.name, 'application/json')
     end
@@ -177,15 +187,19 @@ module Record
       # The method to update records
       # @param module_api_name [String] A String
       # @param request [BodyWrapper] An instance of BodyWrapper
+      # @param header_instance [HeaderMap] An instance of HeaderMap
       # @return An instance of APIResponse
     # @raise SDKException
-    def update_records(module_api_name, request)
+    def update_records(module_api_name, request, header_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 request!=nil and !request.is_a? BodyWrapper
         raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
       end
+      if header_instance!=nil and !header_instance.is_a? HeaderMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
+      end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
       api_path = api_path + '/crm/v2/'
@@ -196,6 +210,7 @@ module Record
       handler_instance.content_type = 'application/json'
       handler_instance.request = request
       handler_instance.mandatory_checker = true
+      handler_instance.header = header_instance
       Util::Utility.get_fields(module_api_name)
       handler_instance.module_api_name = module_api_name
       require_relative 'action_handler'
@@ -205,15 +220,19 @@ module Record
       # The method to delete records
       # @param module_api_name [String] A String
       # @param param_instance [ParameterMap] An instance of ParameterMap
+      # @param header_instance [HeaderMap] An instance of HeaderMap
       # @return An instance of APIResponse
     # @raise SDKException
-    def delete_records(module_api_name, param_instance=nil)
+    def delete_records(module_api_name, param_instance=nil, header_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
+      if header_instance!=nil and !header_instance.is_a? HeaderMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
+      end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
       api_path = api_path + '/crm/v2/'
@@ -222,6 +241,7 @@ module Record
       handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
       handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
       handler_instance.param = param_instance
+      handler_instance.header = header_instance
       require_relative 'action_handler'
       handler_instance.api_call(ActionHandler.name, 'application/json')
     end
@@ -229,15 +249,19 @@ module Record
       # The method to upsert records
       # @param module_api_name [String] A String
       # @param request [BodyWrapper] An instance of BodyWrapper
+      # @param header_instance [HeaderMap] An instance of HeaderMap
       # @return An instance of APIResponse
     # @raise SDKException
-    def upsert_records(module_api_name, request)
+    def upsert_records(module_api_name, request, header_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 request!=nil and !request.is_a? BodyWrapper
         raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
       end
+      if header_instance!=nil and !header_instance.is_a? HeaderMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
+      end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
       api_path = api_path + '/crm/v2/'
@@ -248,6 +272,7 @@ module Record
       handler_instance.category_method = 'ACTION'
       handler_instance.content_type = 'application/json'
       handler_instance.request = request
+      handler_instance.header = header_instance
       Util::Utility.get_fields(module_api_name)
       handler_instance.module_api_name = module_api_name
       require_relative 'action_handler'
@@ -287,15 +312,19 @@ module Record
       # The method to search records
       # @param module_api_name [String] A String
       # @param param_instance [ParameterMap] An instance of ParameterMap
+      # @param header_instance [HeaderMap] An instance of HeaderMap
       # @return An instance of APIResponse
     # @raise SDKException
-    def search_records(module_api_name, param_instance=nil)
+    def search_records(module_api_name, param_instance=nil, header_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
+      if header_instance!=nil and !header_instance.is_a? HeaderMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
+      end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
       api_path = api_path + '/crm/v2/'
@@ -305,6 +334,7 @@ module Record
       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)
       handler_instance.module_api_name = module_api_name
       require_relative 'response_handler'
@@ -394,7 +424,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
@@ -523,6 +553,17 @@ module Record
       def self.If_modified_since
         @@If_modified_since
       end
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.GetRecordHeader')
+      def self.X_external
+        @@X_external
+      end
+    end
+
+    class UpdateRecordHeader
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.UpdateRecordHeader')
+      def self.X_external
+        @@X_external
+      end
     end
 
     class DeleteRecordParam
@@ -532,6 +573,13 @@ module Record
       end
     end
 
+    class DeleteRecordHeader
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.DeleteRecordHeader')
+      def self.X_external
+        @@X_external
+      end
+    end
+
     class GetRecordsParam
       @@approved = Param.new('approved', 'com.zoho.crm.api.Record.GetRecordsParam')
       def self.approved
@@ -596,6 +644,17 @@ module Record
       def self.If_modified_since
         @@If_modified_since
       end
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.GetRecordsHeader')
+      def self.X_external
+        @@X_external
+      end
+    end
+
+    class UpdateRecordsHeader
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.UpdateRecordsHeader')
+      def self.X_external
+        @@X_external
+      end
     end
 
     class DeleteRecordsParam
@@ -609,6 +668,20 @@ module Record
       end
     end
 
+    class DeleteRecordsHeader
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.DeleteRecordsHeader')
+      def self.X_external
+        @@X_external
+      end
+    end
+
+    class UpsertRecordsHeader
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.UpsertRecordsHeader')
+      def self.X_external
+        @@X_external
+      end
+    end
+
     class GetDeletedRecordsParam
       @@type = Param.new('type', 'com.zoho.crm.api.Record.GetDeletedRecordsParam')
       def self.type
@@ -666,6 +739,13 @@ module Record
       end
     end
 
+    class SearchRecordsHeader
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.SearchRecordsHeader')
+      def self.X_external
+        @@X_external
+      end
+    end
+
     class GetMassUpdateStatusParam
       @@job_id = Param.new('job_id', 'com.zoho.crm.api.Record.GetMassUpdateStatusParam')
       def self.job_id

data/src/com/zoho/crm/api/related_records/related_records_operations.rb

@@ -145,15 +145,19 @@ module RelatedRecords
       # The method to update related record
       # @param related_record_id [Integer] A Integer
       # @param request [BodyWrapper] An instance of BodyWrapper
+      # @param header_instance [HeaderMap] An instance of HeaderMap
       # @return An instance of APIResponse
     # @raise SDKException
-    def update_related_record(related_record_id, request)
+    def update_related_record(related_record_id, request, header_instance=nil)
       if !related_record_id.is_a? Integer
         raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_record_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
+      if header_instance!=nil and !header_instance.is_a? HeaderMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
+      end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
       api_path = api_path + '/crm/v2/'
@@ -169,6 +173,7 @@ module RelatedRecords
       handler_instance.category_method = 'UPDATE'
       handler_instance.content_type = 'application/json'
       handler_instance.request = request
+      handler_instance.header = header_instance
       Util::Utility.get_related_lists(@related_list_api_name, @module_api_name, handler_instance)
       require_relative 'action_handler'
       handler_instance.api_call(ActionHandler.name, 'application/json')
@@ -176,12 +181,16 @@ module RelatedRecords
 
       # The method to delink record
       # @param related_record_id [Integer] A Integer
+      # @param header_instance [HeaderMap] An instance of HeaderMap
       # @return An instance of APIResponse
     # @raise SDKException
-    def delink_record(related_record_id)
+    def delink_record(related_record_id, header_instance=nil)
       if !related_record_id.is_a? Integer
         raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: Integer', nil, nil)
       end
+      if header_instance!=nil and !header_instance.is_a? HeaderMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
+      end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
       api_path = api_path + '/crm/v2/'
@@ -195,6 +204,7 @@ module RelatedRecords
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
       handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
+      handler_instance.header = header_instance
       require_relative 'action_handler'
       handler_instance.api_call(ActionHandler.name, 'application/json')
     end
@@ -215,6 +225,10 @@ module RelatedRecords
       def self.If_modified_since
         @@If_modified_since
       end
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsHeader')
+      def self.X_external
+        @@X_external
+      end
     end
 
     class DelinkRecordsParam
@@ -231,5 +245,19 @@ module RelatedRecords
       end
     end
 
+    class UpdateRelatedRecordHeader
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordHeader')
+      def self.X_external
+        @@X_external
+      end
+    end
+
+    class DelinkRecordHeader
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DelinkRecordHeader')
+      def self.X_external
+        @@X_external
+      end
+    end
+
   end
 end

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

@@ -59,7 +59,7 @@ class SDKConfig
   def pick_list_validation
     @pick_list_validation
   end
-
+  
   def open_timeout
     @open_timeout   
   end

data/src/com/zoho/crm/api/util/api_http_connector.rb

@@ -49,6 +49,7 @@ module Util
       http = nil
       initializer = Initializer.get_initializer
       request_proxy = initializer.request_proxy
+
       if request_proxy.nil?
         http = Net::HTTP.new(url.host, url.port)
       else

data/src/com/zoho/crm/api/util/common_api_handler.rb

@@ -88,6 +88,7 @@ module Handler
       converter_instance = nil
 
       if !@content_type.nil? && (Constants::IS_GENERATE_REQUEST_BODY.include? http_method) 
+
         request = nil
 
         begin

data/src/com/zoho/crm/api/util/constants.rb

@@ -100,7 +100,7 @@ class Constants
 
   ZOHO_SDK = 'X-ZOHO-SDK'
 
-  SDK_VERSION = '2.0.0'
+  SDK_VERSION = '2.1.0'
 
   SET_TO_CONTENT_TYPE = ['/crm/bulk/v2/read', '/crm/bulk/v2/write']
 

data/src/com/zoho/crm/api/util/form_data_converter.rb

@@ -50,6 +50,7 @@ module Util
           end
         end
       end
+
       package_name = Utility.path_to_package(class_path)
       class_details = Initializer.json_details[package_name]
       request_hash = {}

data/src/com/zoho/crm/api/util/utility.rb

@@ -29,10 +29,22 @@ module Util
     @@get_modified_modules = false
 
     @@force_refresh = false
+
+    @@module_api_name = nil
     def self.api_supported_module
       @@api_supported_module
     end
+    def self.verify_photo_support(module_api_name)
+    end
     def self.get_fields(module_api_name)
+      @@sync_lock.synchronize do
+        begin
+          @@module_api_name = module_api_name
+          get_fields_info(@@module_api_name)
+        end
+      end
+    end
+    def self.get_fields_info(module_api_name)
       require_relative '../initializer'
       initializer = Initializer.get_initializer
       record_field_details_path = nil
@@ -189,7 +201,7 @@ module Util
         f.write(record_field_details_json.to_json)
       end
       modified_modules.each_key do |module_api_name|
-        get_fields(module_api_name)
+        get_fields_info(module_api_name)
       end
     end
 
@@ -306,7 +318,11 @@ module Util
             error_response[Constants::STATUS] = data_object.status.value
             error_response[Constants::MESSAGE] = data_object.message.value
             error_response[Constants::DETAILS] = data_object.details
-            raise SDKException.new(Constants::API_EXCEPTION, nil, error_response)
+            exception = SDKException.new(Constants::API_EXCEPTION, nil, error_response)
+            if @@module_api_name.downcase == module_api_name.downcase
+              raise exception
+            end
+            SDKLog::SDKLogger.severe(Constants::API_EXCEPTION,exception)
           end
         else
           error_response = {}
@@ -557,7 +573,7 @@ module Util
         end
         field_detail[Constants::LOOKUP] = true
       end
-      get_fields(module_name) if !module_name.nil? && !module_name.empty?
+      get_fields_info(module_name) if !module_name.nil? && !module_name.empty?
       field_detail[Constants::NAME] = key_name
     end
 
@@ -609,7 +625,7 @@ module Util
 
           if related_list_jo[Constants::MODULE] != Constants::NULL_VALUE
             common_api_handler.module_api_name = related_list_jo[Constants::MODULE]
-            get_fields(related_list_jo[Constants::MODULE])
+            get_fields_info(related_list_jo[Constants::MODULE])
           end
           return true
         end
@@ -660,7 +676,7 @@ module Util
 
     def self.refresh_modules
       @@force_refresh = true
-      get_fields(nil)
+      get_fields_info(nil)
       @@force_refresh = false
     end