ZCRMSDK 1.0.5 → 2.0.0

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

@@ -0,0 +1,5 @@
+module Util
+  module Model
+    def initialize; end
+  end
+end

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

@@ -0,0 +1,78 @@
+require 'json'
+require 'monitor'
+
+module Util
+  class ModuleFieldsHandler
+    @@sync_lock = Monitor.new
+
+    def self.delete_fields_file
+      @@sync_lock.synchronize do
+        record_field_details_path = Converter.new(nil).get_record_json_file_path
+        File.delete(record_field_details_path) if File.exist? record_field_details_path
+      end
+    rescue StandardError => e
+      ex = SDKException.new(nil, nil, nil, e)
+      SDKLog::SDKLogger.severe(Constants::DELETE_FIELD_FILE_ERROR, ex)
+      raise ex
+    end
+
+    def self.delete_all_fields_file
+      @@sync_lock.synchronize do
+        initializer = Initializer.get_initializer
+        resources_path = initializer.resources_path + '/' + Constants::RESOURCES
+        if Dir.exist? resources_path
+          Dir.foreach(resources_path) do |f|
+            File.delete(resources_path + '/' + f) if (f != '.') && (f != '..')
+          end
+        end
+      end
+    rescue StandardError => e
+      ex = SDKException.new(nil, nil, nil, e)
+      SDKLog::SDKLogger.severe(Constants::DELETE_FIELD_FILES_ERROR, ex)
+      raise ex
+    end
+
+    def self.delete_fields(module_api_name)
+      record_field_details_path = Converter.new(nil).get_record_json_file_path
+      if File.exist? record_field_details_path
+        record_field_details_json = JSON.parse(File.read(record_field_details_path))
+        if record_field_details_json.key? module_api_name.downcase
+          Utility.delete_fields(record_field_details_json,module_api_name)
+          File.open(record_field_details_path, 'w') do |f|
+            f.write(record_field_details_json.to_json)
+          end
+        end
+      end
+    rescue StandardError => e
+      ex = SDKException.new(nil, nil, nil, e)
+      raise ex
+    end
+
+    def self.refresh_fields(module_api_name)
+      @@sync_lock.synchronize do
+        delete_fields(module_api_name)
+        Utility.get_fields(module_api_name)
+      end
+    rescue SDKException => e
+      SDKLog::SDKLogger.severe(Constants::REFRESH_SINGLE_MODULE_FIELDS_ERROR + module_api_name, e)
+      raise e
+    rescue StandardError => e
+      ex = SDKException.new(nil, nil, nil, e)
+      SDKLog::SDKLogger.severe(Constants::REFRESH_SINGLE_MODULE_FIELDS_ERROR + module_api_name, ex)
+      raise ex
+    end
+
+    def self.refresh_all_modules
+      @@sync_lock.synchronize do
+        Utility.refresh_modules
+      end
+    rescue SDKException => e
+      SDKLog::SDKLogger.severe(Constants::REFRESH_ALL_MODULE_FIELDS_ERROR, e)
+      raise e
+    rescue StandardError => e
+      ex = SDKException.new(nil, nil, nil, e)
+      SDKLog::SDKLogger.severe(Constants::REFRESH_ALL_MODULE_FIELDS_ERROR, ex)
+      raise ex
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require_relative 'model'
+require_relative 'constants'
+
+module Util
+  # This class handles the file stream and name.
+  class StreamWrapper
+    include Model
+
+    # Creates a StreamWrapper class instance with the specified parameters.
+    # @param name [String] A String containing the file name.
+    # @param stream An InputStream containing the file stream.
+    # @param file_path [String] A String containing the absolute file path.
+    def initialize(name = nil, stream = nil, file_path = nil)
+      @name = name
+
+      @stream = stream
+      return if file_path.nil?
+      if File.exist? file_path
+        file = File.open(file_path)
+
+        @name = File.basename(file_path)
+
+        @stream = file.read
+      else 
+        raise SDKException.new(Constants::FILE_ERROR,Constants::FILE_DOES_NOT_EXISTS + " " + file_path)
+      end
+    end
+
+    def name
+      @name
+    end
+
+    def stream
+      @stream
+    end
+  end
+end

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

@@ -0,0 +1,727 @@
+require 'json'
+require 'monitor'
+
+require_relative '../related_lists/related_lists_operations'
+require_relative '../related_lists/related_list'
+require_relative '../fields/fields_operations'
+require_relative '../fields/field'
+require_relative '../fields/response_wrapper'
+require_relative '../fields/api_exception'
+require_relative '../modules/module'
+require_relative '../modules/modules_operations'
+require_relative 'constants'
+require_relative '../exception/sdk_exception'
+require_relative '../../../api/logger/sdk_logger'
+
+module Util
+  # This class handles module field details.
+  class Utility
+    @@sync_lock = Monitor.new
+
+    @@apitype_vs_datatype = {}
+
+    @@apitype_vs_structurename = {}
+
+    @@api_supported_module ={}
+
+    @@new_file = false
+
+    @@get_modified_modules = false
+
+    @@force_refresh = false
+    def self.api_supported_module
+      @@api_supported_module
+    end
+    def self.get_fields(module_api_name)
+      require_relative '../initializer'
+      initializer = Initializer.get_initializer
+      record_field_details_path = nil
+      last_modified_time = nil
+
+      @@sync_lock.synchronize do
+        begin
+          return if !module_api_name.nil? && !search_json_details(module_api_name).nil?
+
+          resoures_folder_path = initializer.resources_path + '/' + Constants::RESOURCES
+
+          Dir.mkdir resoures_folder_path unless File.exist? resoures_folder_path
+          record_field_details_path = get_record_json_file_path
+
+          if File.exist? record_field_details_path
+            record_field_details_json = JSON.parse(File.read(record_field_details_path))
+            last_modified_time_exists = false
+            if @@force_refresh
+              if record_field_details_json.key?(Constants::FIELDS_LAST_MODIFIED_TIME) && !record_field_details_json[Constants::FIELDS_LAST_MODIFIED_TIME].nil?
+                if get_current_time_in_millis - record_field_details_json[Constants::FIELDS_LAST_MODIFIED_TIME] > 3_600_000
+                  last_modified_time_exists = true
+                end
+              end
+            end
+            if initializer.sdk_config.auto_refresh_fields && !@@new_file && !@@get_modified_modules && last_modified_time_exists
+              @@get_modified_modules = true
+              last_modified_time = (record_field_details_json.key? Constants::FIELDS_LAST_MODIFIED_TIME) ? record_field_details_json[Constants::FIELDS_LAST_MODIFIED_TIME] : nil
+              modify_fields(record_field_details_path, last_modified_time)
+              @@get_modified_modules = false
+            elsif !initializer.sdk_config.auto_refresh_fields && @@force_refresh && !@@get_modified_modules
+              @@get_modified_modules = true
+              modify_fields(record_field_details_path, last_modified_time)
+              @@get_modified_modules = false
+            end
+
+            record_field_details_json = JSON.parse(File.read(record_field_details_path))
+            return if module_api_name.nil? || record_field_details_json.key?(module_api_name.downcase)
+
+            fill_data_type
+
+            record_field_details_json[module_api_name.downcase] = {}
+
+            File.open(record_field_details_path, 'w') do |f|
+              f.write(record_field_details_json.to_json)
+            end
+            field_details = get_fields_details(module_api_name)
+            record_field_details_json = JSON.parse(File.read(record_field_details_path))
+
+            record_field_details_json[module_api_name.downcase] = field_details
+
+            File.open(record_field_details_path, 'w') do |f|
+              f.write(record_field_details_json.to_json)
+            end
+
+          elsif initializer.sdk_config.auto_refresh_fields
+            @@new_file = true
+            fill_data_type
+            if @@api_supported_module.length == 0
+              @@api_supported_module = get_modules_api_names(nil)
+            end
+           
+            record_field_details_json = { Constants::FIELDS_LAST_MODIFIED_TIME => get_current_time_in_millis }
+            @@api_supported_module.each_key do |module_name|
+              unless record_field_details_json.key? module_name.downcase
+                record_field_details_json[module_name.downcase] = {}
+                File.open(record_field_details_path, 'w') do |f|
+                  f.write(record_field_details_json.to_json)
+                end
+                field_details = get_fields_details(module_name)
+                record_field_details_json = JSON.parse(File.read(record_field_details_path))
+                record_field_details_json[module_name.downcase] = field_details
+                File.open(record_field_details_path, 'w') do |f|
+                  f.write(record_field_details_json.to_json)
+                end
+              end
+            end
+            @@new_file = false
+          elsif @@force_refresh && !@@get_modified_modules
+            @@get_modified_modules = true
+            record_field_details_json = {}
+            File.open(record_field_details_path, 'w') do |f|
+              f.write(record_field_details_json.to_json)
+            end
+            modify_fields(record_field_details_path, last_modified_time)
+            @@get_modified_modules = false
+          else
+            fill_data_type
+
+            record_field_details_json = { module_api_name.downcase => {} }
+
+            File.open(record_field_details_path, 'w') do |f|
+              f.write(record_field_details_json.to_json)
+            end
+            field_details = get_fields_details(module_api_name)
+            record_field_details_json = JSON.parse(File.read(record_field_details_path))
+            record_field_details_json[module_api_name.downcase] = field_details
+
+            File.open(record_field_details_path, 'w') do |f|
+              f.write(record_field_details_json.to_json)
+            end
+          end
+        rescue StandardError => e
+          if !record_field_details_path.nil? && File.exist?(record_field_details_path)
+            begin
+              record_field_details_json = JSON.parse(File.read(record_field_details_path))
+              if record_field_details_json.key? module_api_name.downcase
+                record_field_details_json.delete(module_api_name.downcase)
+              end
+              if @@new_file
+                unless record_field_details_json[Constants::FIELDS_LAST_MODIFIED_TIME].nil?
+                  record_field_details_json.delete(Constants::FIELDS_LAST_MODIFIED_TIME)
+                end
+                @@new_file = false
+              end
+              if @@get_modified_modules || @@force_refresh
+                @@get_modified_modules = false
+                @@force_refresh = false
+                unless last_modified_time.nil?
+                  record_field_details_json[Constants::FIELDS_LAST_MODIFIED_TIME] = last_modified_time
+                end
+              end
+              File.open(record_field_details_path, 'w') do |f|
+                f.write(record_field_details_json.to_json)
+              end
+            rescue StandardError => e
+              exception = SDKException.new(nil, Constants::EXCEPTION, nil, e)
+              SDKLog::SDKLogger.severe(Constants::EXCEPTION, exception)
+              raise exception
+            end
+          end
+          ex = (e.class.to_s == 'SDKException') ? e : SDKException.new(nil, Constants::EXCEPTION, nil, e)
+          SDKLog::SDKLogger.severe(Constants::EXCEPTION, ex)
+          raise ex
+        end
+      end
+    end
+
+    def self.modify_fields(record_field_details_path, modified_time)
+      modified_modules = get_modules_api_names(modified_time)
+      record_field_details_json = JSON.parse(File.open(record_field_details_path).read)
+      record_field_details_json[Constants::FIELDS_LAST_MODIFIED_TIME] = get_current_time_in_millis
+      File.open(record_field_details_path, 'w') do |f|
+        f.write(record_field_details_json.to_json)
+      end
+      return unless modified_modules.any?
+
+      modified_modules.each_key do |module_api_name|
+        if record_field_details_json.key? module_api_name.downcase
+          delete_fields(record_field_details_json, module_api_name)
+        end
+      end
+
+      File.open(record_field_details_path, 'w') do |f|
+        f.write(record_field_details_json.to_json)
+      end
+      modified_modules.each_key do |module_api_name|
+        get_fields(module_api_name)
+      end
+    end
+
+    def self.delete_fields(record_field_details_json, module_api_name)
+      subform_modules = []
+
+      field_json = record_field_details_json[module_api_name.downcase]
+      field_json.each_key do |key|
+        if field_json[key].key?(Constants::SUBFORM) && field_json[key][Constants::SUBFORM] 
+          if record_field_details_json.key? field_json[key][Constants::MODULE]
+            subform_modules.push(field_json[key][Constants::MODULE])
+          end
+        end
+      end
+      record_field_details_json.delete(module_api_name.downcase)
+      return unless subform_modules.any?
+
+      subform_modules.each do |subform_module|
+        delete_fields(record_field_details_json, subform_module)
+      end
+    end
+
+    def self.get_record_json_file_path
+      Converter.new(nil).get_record_json_file_path
+    end
+
+    def self.get_related_lists(related_module_name, module_api_name, common_api_handler)
+      require_relative '../initializer'
+
+      initializer = Initializer.get_initializer
+
+      @@sync_lock.synchronize do
+        begin
+          is_new_data = false
+          key = module_api_name + Constants::UNDERSCORE + Constants::RELATED_LISTS
+          key = key.downcase
+          resoures_folder_path = initializer.resources_path + '/' + Constants::RESOURCES
+          Dir.mkdir resoures_folder_path unless File.exist? resoures_folder_path
+
+          record_field_details_path = get_record_json_file_path
+          if !File.exist?(record_field_details_path) || (File.exist?(record_field_details_path) && !(JSON.parse(File.read(record_field_details_path)).key? key))
+            is_new_data = true
+            related_list_values = get_related_list_details(module_api_name)
+            record_field_details_json = {}
+            if File.exist? record_field_details_path
+              record_field_details_json = JSON.parse(File.read(record_field_details_path))
+            end
+            record_field_details_json[key] = related_list_values
+            File.open(record_field_details_path, 'w') do |f|
+              f.write(record_field_details_json.to_json)
+            end
+          end
+          record_field_details_json = JSON.parse(File.read(record_field_details_path))
+          module_related_list = record_field_details_json[key]
+          if !check_related_list_exists(related_module_name, module_related_list, common_api_handler) && !is_new_data
+            record_field_details_json.delete(key)
+            File.open(record_field_details_path, 'w') do |f|
+              f.write(record_field_details_json.to_json)
+            end
+            get_related_lists(related_module_name, module_api_name, common_api_handler)
+          end
+        rescue SDKException => e
+          SDKLog::SDKLogger.severe(Constants::EXCEPTION, e)
+        rescue StandardError => e
+          ex = SDKException.new(nil, Constants::EXCEPTION, nil, e)
+          SDKLog::SDKLogger.severe(Constants::EXCEPTION, ex)
+          raise ex
+        end
+      end
+    end
+
+    def self.get_fields_details(module_api_name)
+      response = Fields::FieldsOperations.new(module_api_name).get_fields(nil)
+      fields_details = {}
+
+      unless response.nil?
+
+        return fields_details if response.status_code == Constants::RESPONSECODE_NO_CONTENT
+
+        if response.is_expected
+          data_object = response.data_object
+
+          if data_object.is_a? Fields::ResponseWrapper
+            fields = data_object.fields
+
+            fields.each do |field|
+              key_name = field.api_name
+              next if Constants::KEYS_TO_SKIP.include? key_name
+
+              field_detail = {}
+              set_data_type(field_detail, field, module_api_name)
+              fields_details[key_name] = field_detail
+            end
+            if Constants::INVENTORY_MODULES.include? module_api_name.downcase
+              field_detail = {}
+              field_detail[Constants::NAME] = Constants::LINE_TAX
+              field_detail[Constants::TYPE] = Constants::LIST_NAMESPACE
+              field_detail[Constants::STRUCTURE_NAME] = Constants::LINE_TAX_NAMESPACE
+              field_detail[Constants::LOOKUP] = true
+              fields_details[Constants::LINE_TAX] = field_detail
+            end
+
+            if module_api_name.downcase == Constants::NOTES.downcase
+              field_detail = {}
+              field_detail[Constants::NAME] = Constants::ATTACHMENTS
+              field_detail[Constants::TYPE] = Constants::LIST_NAMESPACE
+              field_detail[Constants::STRUCTURE_NAME] = Constants::ATTACHMENTS_NAMESPACE
+              fields_details[Constants::ATTACHMENTS] = field_detail
+            end
+
+          elsif data_object.is_a? Fields::APIException
+            error_response = {}
+            error_response[Constants::CODE] = data_object.code.value
+            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)
+          end
+        else
+          error_response = {}
+          error_response[Constants::CODE] = response.status_code
+          raise SDKException.new(Constants::API_EXCEPTION, nil, error_response)
+        end
+      end
+      fields_details
+    end
+
+    def self.search_json_details(key)
+      require_relative '../initializer'
+
+      package_name = Constants::PACKAGE_PREFIX + 'record.' + key
+
+      Initializer.json_details.each_key do |class_key|
+        if class_key.downcase == package_name.downcase
+          return_json = {
+            Constants::MODULEPACKAGENAME => class_key,
+            Constants::MODULEDETAILS => Initializer.json_details[class_key]
+          }
+
+          return return_json
+        end
+      end
+
+      nil
+    end
+
+    def self.get_json_object(json, key)
+      json.each_key do |key_in_json|
+        return json[key_in_json] if key_in_json == key
+      end
+
+      nil
+    end
+
+    def self.fill_data_type
+      return unless @@apitype_vs_datatype.empty?
+
+      field_api_names_string = %w[autonumber textarea text website email phone mediumtext multiselectlookup profileimage]
+      field_api_names_integer = %w[integer]
+      field_api_names_boolean = %w[boolean]
+      field_api_names_long = %w[bigint long]
+      field_api_names_double = %w[double percent lookup currency]
+      field_api_names_file = %w[imageupload]
+      field_api_names_field_file = %w[fileupload]
+      field_api_names_datetime = %w[datetime event_reminder]
+      field_api_names_date = %w[date]
+      field_api_names_lookup = %w[lookup]
+      field_api_names_picklist = %w[picklist]
+      field_api_names_multiselect_picklist = %w[multiselectpicklist]
+      field_api_names_subform = %w[subform]
+      field_api_names_owner_lookup = %w[ownerlookup userlookup]
+      field_api_names_multiuser_lookup = %w[multiuserlookup]
+      field_api_names_multimodule_lookup = %w[multimodulelookup]
+      field_api_names_task_remind_at = %w[ALARM]
+      field_api_names_recurring_activity = %w[RRULE]
+      field_api_names_reminder = %w[multireminder]
+      field_api_names_consent_look_up = %w[consent_lookup]
+
+      field_api_names_string.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::STRING
+      end
+
+      field_api_names_integer.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::INTEGER
+      end
+
+      field_api_names_boolean.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::BOOLEAN
+      end
+
+      field_api_names_double.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::DOUBLE
+      end
+
+      field_api_names_long.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::LONG
+      end
+
+      field_api_names_file.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::FILE_NAMESPACE
+      end
+
+      field_api_names_field_file.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::LIST_NAMESPACE
+        @@apitype_vs_structurename[field_api_name] = Constants::FIELD_FILE_NAMESPACE
+      end
+
+      field_api_names_task_remind_at.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::REMINDAT_NAMESPACE
+        @@apitype_vs_structurename[field_api_name] = Constants::REMINDAT_NAMESPACE
+      end
+
+      field_api_names_recurring_activity.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::RECURRING_ACTIVITY_NAMESPACE
+        @@apitype_vs_structurename[field_api_name] = Constants::RECURRING_ACTIVITY_NAMESPACE
+      end
+
+      field_api_names_reminder.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::LIST_NAMESPACE
+        @@apitype_vs_structurename[field_api_name] = Constants::REMINDER_NAMESPACE
+      end
+
+      field_api_names_datetime.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::DATETIME_NAMESPACE
+      end
+
+      field_api_names_date.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::DATE_NAMESPACE
+      end
+
+      field_api_names_lookup.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::RECORD_NAMESPACE
+
+        @@apitype_vs_structurename[field_api_name] = Constants::RECORD_NAMESPACE
+      end
+
+      field_api_names_owner_lookup.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::USER_NAMESPACE
+
+        @@apitype_vs_structurename[field_api_name] = Constants::USER_NAMESPACE
+      end
+
+      field_api_names_multiuser_lookup.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::LIST_NAMESPACE
+
+        @@apitype_vs_structurename[field_api_name] = Constants::USER_NAMESPACE
+      end
+
+      field_api_names_multimodule_lookup.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::LIST_NAMESPACE
+
+        @@apitype_vs_structurename[field_api_name] = Constants::MODULE_NAMESPACE
+      end
+
+      field_api_names_picklist.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::CHOICE_NAMESPACE
+      end
+
+      field_api_names_multiselect_picklist.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::LIST_NAMESPACE
+
+        @@apitype_vs_structurename[field_api_name] = Constants::CHOICE_NAMESPACE
+      end
+
+      field_api_names_subform.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::LIST_NAMESPACE
+
+        @@apitype_vs_structurename[field_api_name] = Constants::RECORD_NAMESPACE
+      end
+
+      field_api_names_consent_look_up.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::CONSENT_NAMESPACE
+
+        @@apitype_vs_structurename[field_api_name] = Constants::CONSENT_NAMESPACE
+      end
+    end
+
+    def self.set_data_type(field_detail, field_instance, module_api_name)
+      data_type = field_instance.data_type
+
+      key_name = field_instance.api_name
+
+      module_name = ''
+
+      module_api_name = module_api_name.downcase
+      if !field_instance.system_mandatory.nil? && field_instance.system_mandatory && !((module_api_name == Constants::CALLS.downcase) && (key_name.downcase == Constants::CALL_DURATION.downcase))
+        field_detail[Constants::REQUIRED] = true
+      end
+      if Constants::INVENTORY_MODULES.include?(module_api_name) && (key_name.downcase == Constants::PRODUCT_DETAILS.downcase)
+        field_detail[Constants::NAME] = key_name
+        field_detail[Constants::TYPE] = Constants::LIST_NAMESPACE
+        field_detail[Constants::STRUCTURE_NAME] = Constants::INVENTORY_LINE_ITEMS
+        field_detail[Constants::SKIP_MANDATORY] = true
+        return
+      elsif (key_name.downcase == Constants::PRICING_DETAILS.downcase) && (module_api_name == Constants::PRICE_BOOKS.downcase)
+        field_detail[Constants::NAME] = key_name
+        field_detail[Constants::TYPE] = Constants::LIST_NAMESPACE
+        field_detail[Constants::STRUCTURE_NAME] = Constants::PRICINGDETAILS
+        field_detail[Constants::SKIP_MANDATORY] = true
+        return
+      elsif (key_name.downcase == Constants::PARTICIPANT_API_NAME.downcase) && ((module_api_name == Constants::EVENTS.downcase) || (module_api_name == Constants::ACTIVITIES.downcase))
+        field_detail[Constants::NAME] = key_name
+        field_detail[Constants::TYPE] = Constants::LIST_NAMESPACE
+        field_detail[Constants::STRUCTURE_NAME] = Constants::PARTICIPANTS
+        field_detail[Constants::SKIP_MANDATORY] = true
+        return
+      elsif (key_name.downcase == Constants::COMMENTS.downcase) && ((module_api_name == Constants::SOLUTIONS.downcase) || (module_api_name == Constants::CASES.downcase))
+        field_detail[Constants::NAME] = key_name
+        field_detail[Constants::TYPE] = Constants::LAYOUT_NAMESPACE
+        field_detail[Constants::STRUCTURE_NAME] = Constants::COMMENTS_NAMESPACE
+        field_detail[Constants::LOOKUP] = true
+        return
+      elsif key_name.downcase == Constants::LAYOUT.downcase
+        field_detail[Constants::NAME] = key_name
+        field_detail[Constants::TYPE] = Constants::LAYOUT_NAMESPACE
+        field_detail[Constants::LOOKUP] = true
+        field_detail[Constants::STRUCTURE_NAME] = Constants::LAYOUT_NAMESPACE
+        return
+      elsif @@apitype_vs_datatype.include? data_type
+        field_detail[Constants::TYPE] = @@apitype_vs_datatype[data_type]
+      elsif data_type.downcase == Constants::FORMULA.downcase
+        unless field_instance.formula.nil?
+          return_type = field_instance.formula.return_type
+          unless @@apitype_vs_datatype[return_type].nil?
+            field_detail[Constants::TYPE] = @@apitype_vs_datatype[return_type]
+          end
+          field_detail[Constants::READ_ONLY] = true
+        end
+      else
+        return
+      end
+      field_detail[Constants::LOOKUP] = true if data_type.downcase.include? Constants::LOOKUP
+      field_detail[Constants::SKIP_MANDATORY] = true if data_type.downcase.include? Constants::CONSENT_LOOKUP
+
+      if @@apitype_vs_structurename.include? data_type
+        field_detail[Constants::STRUCTURE_NAME] = @@apitype_vs_structurename[data_type]
+      end
+
+      if (field_instance.data_type.downcase == Constants::PICKLIST.downcase) && !field_instance.pick_list_values.nil? && !field_instance.pick_list_values.empty?
+        values = []
+
+        field_instance.pick_list_values.each do |pick_list_value|
+          values.push(pick_list_value.display_value)
+        end
+        field_detail[Constants::PICKLIST] = true
+        field_detail[Constants::VALUES] = values
+      end
+
+      if data_type.downcase == Constants::SUBFORM.downcase
+        module_name = field_instance.subform.module
+        field_detail[Constants::SUBFORM] = true
+        field_detail[Constants::SKIP_MANDATORY] = true
+        field_detail[Constants::MODULE] = module_name
+      end
+
+      if data_type.downcase == Constants::LOOKUP.downcase
+        module_name = field_instance.lookup.module
+        if !module_name.nil? && (module_name.downcase != Constants::SE_MODULE.downcase)
+          field_detail[Constants::MODULE] = module_name
+          if (module_name.downcase == Constants::ACCOUNTS.downcase) && !field_instance.custom_field
+            field_detail[Constants::SKIP_MANDATORY] = true
+          end
+        else
+          module_name = ''
+        end
+        field_detail[Constants::LOOKUP] = true
+      end
+      get_fields(module_name) if !module_name.nil? && !module_name.empty?
+      field_detail[Constants::NAME] = key_name
+    end
+
+    def self.get_modules
+      @@sync_lock.synchronize do
+        @@api_supported_module = get_modules_api_names(nil)
+      end
+    end
+    def self.get_modules_api_names(header)
+      api_names = {}
+      header_map = HeaderMap.new
+      unless header.nil?
+        header_value = Time.at(header.to_i / 1000).iso8601
+        header_map.add(Modules::ModulesOperations::GetModulesHeader.If_modified_since, header_value)
+      end
+      response = Modules::ModulesOperations.new.get_modules(header_map)
+
+      unless response.nil?
+        if [Constants::RESPONSECODE_NO_CONTENT, Constants::RESPONSECODE_NOT_MODIFIED].include? response.status_code
+          return api_names
+        end
+
+        if response.is_expected
+          response_object = response.data_object
+          if response_object.is_a? Modules::ResponseWrapper
+            modules = response_object.modules
+            modules.each do |module_ins|
+              api_names[module_ins.api_name.downcase] = module_ins.generated_type.value if module_ins.api_supported
+            end
+          elsif response_object.is_a? Modules::APIException
+            error_response = {}
+            error_response[Constants::CODE] = response_object.code.value
+            error_response[Constants::STATUS] = response_object.status.value
+            error_response[Constants::MESSAGE] = response_object.message.value
+            raise SDKException.new(Constants::API_EXCEPTION, nil, error_response)
+          end
+        end
+      end
+      api_names
+    end
+
+    def self.check_related_list_exists(related_module_name, module_related_list_ja, common_api_handler)
+      (0..module_related_list_ja.length - 1).each do |i|
+        related_list_jo = module_related_list_ja[i]
+        if !related_list_jo[Constants::API_NAME].nil? && (related_list_jo[Constants::API_NAME].downcase == related_module_name.downcase)
+          if related_list_jo[Constants::HREF] == Constants::NULL_VALUE
+            raise SDKException.new(Constants::UNSUPPORTED_IN_API, common_api_handler.http_method + ' ' + common_api_handler.api_path + Constants::UNSUPPORTED_IN_API_MESSAGE)
+          end
+
+          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])
+          end
+          return true
+        end
+      end
+      false
+    end
+
+    def self.get_related_list_details(module_api_name)
+      rlo = RelatedLists::RelatedListsOperations.new(module_api_name)
+      response = rlo.get_related_lists
+      related_lists_ja = []
+      unless response.nil?
+        return related_lists_ja if response.status_code == Constants::RESPONSECODE_NO_CONTENT
+
+        if response.is_expected
+          response_handler = response.data_object
+          if response_handler.is_a? RelatedLists::ResponseWrapper
+            response_wrapper = response_handler
+            related_lists = response_wrapper.related_lists
+            related_lists.each do |related_list|
+              related_list_detail = {}
+              related_list_detail[Constants::API_NAME] = related_list.api_name
+              related_list_detail[Constants::MODULE] = related_list.module.nil? ? Constants::NULL_VALUE : related_list.module
+              related_list_detail[Constants::NAME] = related_list.name
+              related_list_detail[Constants::HREF] = related_list.href.nil? ? Constants::NULL_VALUE : related_list.href
+              related_lists_ja.push(related_list_detail)
+            end
+          elsif response_handler.is_a? RelatedLists::APIException
+            exception = response_handler
+            error_response = {}
+            error_response[Constants::CODE] = exception.code.value
+            error_response[Constants::STATUS] = exception.status.value
+            error_response[Constants::MESSAGE] = exception.message.value
+            raise SDKException.new(Constants::API_EXCEPTION, nil, error_response)
+          end
+        else
+          error_response = {}
+          error_response[Constants::CODE] = response.status_code
+          raise SDKException.new(Constants::API_EXCEPTION, nil, error_response)
+        end
+      end
+      related_lists_ja
+    end
+
+    def self.get_current_time_in_millis
+      (Time.now.to_f * 1000).to_i
+    end
+
+    def self.refresh_modules
+      @@force_refresh = true
+      get_fields(nil)
+      @@force_refresh = false
+    end
+
+    def self.classname_to_filename(class_name)
+      changed_class_name = ''
+      camel_case_split = (class_name.to_s.split(/([[:upper:]][[:lower:]]+)/)).delete_if(&:empty?)
+      camel_case_split.each_with_index do |each_name, i|
+        changed_class_name += Constants::UNDERSCORE if i.positive?
+        changed_class_name += each_name.to_s.downcase
+      end
+
+      changed_class_name
+    end
+
+    def self.class_to_load(class_path)
+      package_to_load = ''
+
+      class_path = class_path.to_s
+
+      split_names = class_path.split(Constants::DOT)
+
+      package_name_split = split_names[-2].to_s.split(Constants::UNDERSCORE)
+
+      package_name_split.each do |name|
+        name[0] = name[0].to_s.upcase
+        package_to_load += name
+      end
+
+      package_to_load += Constants::DOUBLE_COLON
+
+      package_to_load += split_names[-1]
+
+      package_to_load
+    end
+
+    def self.path_to_package(class_path)
+      if class_path.to_s.include? Constants::DOUBLE_COLON
+        name = Constants::PACKAGE_PREFIX
+        class_path = class_path.to_s
+        class_split = class_path.to_s.split(Constants::DOUBLE_COLON)
+        class_split[0] = classname_to_filename(class_split[0])
+        name += class_split[0] + Constants::DOT + class_split[1]
+        name
+      else
+        class_path
+      end
+    end
+
+    def self.check_data_type(value,type)
+      if value.nil?
+        return false
+      end
+      if type.downcase == Constants::OBJECT.downcase
+        return true
+      end
+      type = Constants::DATA_TYPE[type].downcase
+      class_name = value.class.name.downcase
+      if type == Constants::BOOLEAN.downcase
+        class_name = ([true, false].include? value) ? Constants::BOOLEAN.downcase : class_name
+      end
+      class_name == type
+    end
+  end
+end