ZOHOCRMSDK2_0 1.0.0 → 2.0.0

data/src/com/zoho/crm/api/dc/au_datacenter.rb

@@ -11,8 +11,8 @@ module DC
       'https://content.zohoapis.com.au'
     end
 
-    PRODUCTION = Environment.new('https://www.zohoapis.com.au', AUDataCenter.new.get_iam_url, AUDataCenter.new.get_file_upload_url)
-    SANDBOX = Environment.new('https://sandbox.zohoapis.com.au', AUDataCenter.new.get_iam_url, AUDataCenter.new.get_file_upload_url)
-    DEVELOPER = Environment.new('https://developer.zohoapis.com.au', AUDataCenter.new.get_iam_url, AUDataCenter.new.get_file_upload_url)
+    PRODUCTION = Environment.new('https://www.zohoapis.com.au', AUDataCenter.new.get_iam_url, AUDataCenter.new.get_file_upload_url,"au_prd")
+    SANDBOX = Environment.new('https://sandbox.zohoapis.com.au', AUDataCenter.new.get_iam_url, AUDataCenter.new.get_file_upload_url,"au_sdb")
+    DEVELOPER = Environment.new('https://developer.zohoapis.com.au', AUDataCenter.new.get_iam_url, AUDataCenter.new.get_file_upload_url,"au_dev")
   end
 end

data/src/com/zoho/crm/api/dc/cn_datacenter.rb

@@ -11,8 +11,8 @@ module DC
       'https://content.zohoapis.com.cn'
     end
 
-    PRODUCTION = Environment.new('https://www.zohoapis.com.cn', CNDataCenter.new.get_iam_url, CNDataCenter.new.get_file_upload_url)
-    SANDBOX = Environment.new('https://sandbox.zohoapis.com.cn', CNDataCenter.new.get_iam_url, CNDataCenter.new.get_file_upload_url)
-    DEVELOPER = Environment.new('https://developer.zohoapis.com.cn', CNDataCenter.new.get_iam_url, CNDataCenter.new.get_file_upload_url)
+    PRODUCTION = Environment.new('https://www.zohoapis.com.cn', CNDataCenter.new.get_iam_url, CNDataCenter.new.get_file_upload_url,"cn_prd")
+    SANDBOX = Environment.new('https://sandbox.zohoapis.com.cn', CNDataCenter.new.get_iam_url, CNDataCenter.new.get_file_upload_url,"cn_sdb")
+    DEVELOPER = Environment.new('https://developer.zohoapis.com.cn', CNDataCenter.new.get_iam_url, CNDataCenter.new.get_file_upload_url,"cn_dev")
   end
 end

data/src/com/zoho/crm/api/dc/datacenter.rb

@@ -9,11 +9,12 @@ module DC
     end
 
     class Environment
-      attr_reader :accounts_url, :url, :file_upload_url
-      def initialize(url, accounts_url, file_upload_url)
+      attr_reader :accounts_url, :url, :file_upload_url,:name
+      def initialize(url, accounts_url, file_upload_url, name)
         @url = url
         @accounts_url = accounts_url
         @file_upload_url = file_upload_url
+        @name = name
       end
     end
   end

data/src/com/zoho/crm/api/dc/eu_datacenter.rb

@@ -11,8 +11,8 @@ module DC
       'https://content.zohoapis.eu'
     end
 
-    PRODUCTION = Environment.new('https://www.zohoapis.eu', EUDataCenter.new.get_iam_url, EUDataCenter.new.get_file_upload_url)
-    SANDBOX = Environment.new('https://sandbox.zohoapis.eu', EUDataCenter.new.get_iam_url, EUDataCenter.new.get_file_upload_url)
-    DEVELOPER = Environment.new('https://developer.zohoapis.eu', EUDataCenter.new.get_iam_url, EUDataCenter.new.get_file_upload_url)
+    PRODUCTION = Environment.new('https://www.zohoapis.eu', EUDataCenter.new.get_iam_url, EUDataCenter.new.get_file_upload_url,"eu_prd")
+    SANDBOX = Environment.new('https://sandbox.zohoapis.eu', EUDataCenter.new.get_iam_url, EUDataCenter.new.get_file_upload_url,"eu_sdb")
+    DEVELOPER = Environment.new('https://developer.zohoapis.eu', EUDataCenter.new.get_iam_url, EUDataCenter.new.get_file_upload_url,"eu_dev")
   end
 end

data/src/com/zoho/crm/api/dc/in_datacenter.rb

@@ -11,8 +11,8 @@ module DC
       'https://content.zohoapis.in'
     end
 
-    PRODUCTION = Environment.new('https://www.zohoapis.in', INDataCenter.new.get_iam_url, INDataCenter.new.get_file_upload_url)
-    SANDBOX = Environment.new('https://sandbox.zohoapis.in', INDataCenter.new.get_iam_url, INDataCenter.new.get_file_upload_url)
-    DEVELOPER = Environment.new('https://developer.zohoapis.in', INDataCenter.new.get_iam_url, INDataCenter.new.get_file_upload_url)
+    PRODUCTION = Environment.new('https://www.zohoapis.in', INDataCenter.new.get_iam_url, INDataCenter.new.get_file_upload_url,"in_prd")
+    SANDBOX = Environment.new('https://sandbox.zohoapis.in', INDataCenter.new.get_iam_url, INDataCenter.new.get_file_upload_url,"in_sdb")
+    DEVELOPER = Environment.new('https://developer.zohoapis.in', INDataCenter.new.get_iam_url, INDataCenter.new.get_file_upload_url,"in_dev")
   end
 end

data/src/com/zoho/crm/api/dc/us_datacenter.rb

@@ -11,8 +11,8 @@ module DC
       'https://content.zohoapis.com'
     end
 
-    PRODUCTION = Environment.new('https://www.zohoapis.com', USDataCenter.new.get_iam_url, USDataCenter.new.get_file_upload_url)
-    SANDBOX = Environment.new('https://sandbox.zohoapis.com', USDataCenter.new.get_iam_url, USDataCenter.new.get_file_upload_url)
-    DEVELOPER = Environment.new('https://developer.zohoapis.com', USDataCenter.new.get_iam_url, USDataCenter.new.get_file_upload_url)
+    PRODUCTION = Environment.new('https://www.zohoapis.com', USDataCenter.new.get_iam_url, USDataCenter.new.get_file_upload_url,"us_prd")
+    SANDBOX = Environment.new('https://sandbox.zohoapis.com', USDataCenter.new.get_iam_url, USDataCenter.new.get_file_upload_url,"us_sdb")
+    DEVELOPER = Environment.new('https://developer.zohoapis.com', USDataCenter.new.get_iam_url, USDataCenter.new.get_file_upload_url,"us_dev")
   end
 end

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

@@ -7,8 +7,7 @@ require_relative 'util/constants'
 
 # This class to initialize Zoho CRM SDK.
 class Initializer
-  attr_accessor :json_details, :user, :environment, :store, :token, :initializer, :local, :sdk_config, :resources_path, :request_proxy
-
+  attr_accessor :json_details,:user, :environment, :store, :token, :initializer, :local, :sdk_config, :resources_path, :request_proxy
   @@json_details = nil
 
   Thread.current['initi'] = nil
@@ -17,7 +16,7 @@ class Initializer
     @@json_details
   end
 
-  def self.initialize(user, environment, token, store, sdk_config, resources_path, log = nil, request_proxy = nil)
+  def self.initialize(user:, environment:, token:, store:, sdk_config:, resources_path:, log: nil, request_proxy: nil)
     error = {}
 
     require_relative 'user_signature'
@@ -27,7 +26,7 @@ class Initializer
 
       error[Constants::ERROR_HASH_EXPECTED_TYPE] = UserSignature
 
-      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::USERSIGNATURE_ERROR_MESSAGE, error, nil)
+      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::USER_SIGNATURE_ERROR_MESSAGE, error, nil)
 
     end
 
@@ -75,12 +74,20 @@ class Initializer
 
     end
 
+    if !request_proxy.nil? && !sdk_config.is_a?(RequestProxy)
+
+      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::REQUEST_PROXY_ERROR, nil, nil)
+    end
+
     if resources_path.nil? || resources_path.empty?
       raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::RESOURCE_PATH_ERROR_MESSAGE, nil, nil)
     end
 
-    log = SDKLog::Log.initialize(Levels::INFO, File.join(Dir.pwd, Constants::LOGFILE_NAME)) if log.nil? 
+    if !File.directory?(resources_path)
+      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::RESOURCE_PATH_INVALID_ERROR_MESSAGE, nil, nil)
+    end
 
+    log = SDKLog::Log.initialize(level: Levels::INFO, path: File.join(Dir.pwd, Constants::LOGFILE_NAME)) if log.nil? 
     SDKLog::SDKLogger.initialize(log)
 
     @@initializer = Initializer.new
@@ -109,7 +116,10 @@ class Initializer
   end
 
   def self.get_JSONDetails
-    JSON.parse(File.open(File.join(File.dirname(File.expand_path(__FILE__)), '../../../../' + Constants::JSON_DETAILS_FILE_PATH)).read)
+    if @@json_details.nil? || @@json_details.length == 0
+      return JSON.parse(File.open(File.join(File.dirname(File.expand_path(__FILE__)), '../../../../' + Constants::JSON_DETAILS_FILE_PATH)).read)
+    end
+    @@json_details
   rescue StandardError => e
     raise SDKException.new(nil, Constants::EXCEPTION_JSONDETAILS, nil, e)
   end
@@ -120,21 +130,26 @@ class Initializer
     @@initializer
   end
 
-  def self.switch_user(user, environment, token, sdk_config, request_proxy = nil)
+  def self.switch_user(user:nil, environment:nil, token:nil, sdk_config:nil, request_proxy: nil)
+    
+    if @@initializer.nil?
+      raise SDKException.new(Constants::SDK_UNINITIALIZATION_ERROR, Constants::SDK_UNINITIALIZATION_MESSAGE)
+    end
+
     require_relative 'user_signature'
 
-    unless user.is_a?(UserSignature)
+    if !user.nil? and !user.is_a?(UserSignature)
       error[Constants::ERROR_HASH_FIELD] = 'user'
 
       error[Constants::ERROR_HASH_EXPECTED_TYPE] = UserSignature
 
-      raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::USERSIGNATURE_ERROR_MESSAGE, error, nil)
+      raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::USER_SIGNATURE_ERROR_MESSAGE, error, nil)
 
     end
 
     require_relative '../../crm/api/dc/datacenter'
 
-    unless environment.is_a?(DC::DataCenter::Environment)
+    if !environment.nil? and !environment.is_a?(DC::DataCenter::Environment)
       error[Constants::ERROR_HASH_FIELD] = 'environment'
 
       error[Constants::ERROR_HASH_EXPECTED_TYPE] = DC::DataCenter::Environment
@@ -145,7 +160,7 @@ class Initializer
 
     require_relative '../../api/authenticator/token'
 
-    unless token.is_a?(Authenticator::Token)
+    if !token.nil? and !token.is_a?(Authenticator::Token)
       error[Constants::ERROR_HASH_FIELD] = 'token'
 
       error[Constants::ERROR_HASH_EXPECTED_TYPE] = Authenticator::Token
@@ -154,9 +169,20 @@ class Initializer
 
     end
 
+    require_relative 'request_proxy'
+
+    if !request_proxy.nil? and !request_proxy.is_a?(RequestProxy)
+      error[Constants::ERROR_HASH_FIELD] = 'request_proxy'
+
+      error[Constants::ERROR_HASH_EXPECTED_TYPE] = RequestProxy
+
+      raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::REQUEST_PROXY_ERROR_MESSAGE, error, nil)
+
+    end
+
     require_relative 'sdk_config'
 
-    unless sdk_config.is_a?(SDKConfig)
+    if !sdk_config.nil? and !sdk_config.is_a?(SDKConfig)
       error[Constants::ERROR_HASH_FIELD] = 'sdk_config'
 
       error[Constants::ERROR_HASH_EXPECTED_TYPE] = SDKConfig
@@ -167,13 +193,15 @@ class Initializer
 
     initializer = Initializer.new
 
-    initializer.user = user
+    previous_initializer = Initializer.get_initializer
+
+    initializer.user = user.nil? ? previous_initializer.user : user
 
-    initializer.environment = environment
+    initializer.environment = environment.nil? ? previous_initializer.environment : environment
 
-    initializer.sdk_config = sdk_config
+    initializer.sdk_config = sdk_config.nil? ? previous_initializer.sdk_config : sdk_config
 
-    initializer.token = token
+    initializer.token = token.nil? ? previous_initializer.token : token
 
     initializer.store = @@initializer.store
 

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

@@ -159,15 +159,19 @@ module Record
       # The method to create 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 create_records(module_api_name, request)
+    def create_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/'
@@ -178,6 +182,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'
@@ -509,6 +514,116 @@ module Record
       handler_instance.api_call(MassUpdateResponseHandler.name, 'application/json')
     end
 
+      # The method to get record using external id
+      # @param external_field_value [String] A String
+      # @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 get_record_using_external_id(external_field_value, module_api_name, param_instance=nil, header_instance=nil)
+      if !external_field_value.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: String', nil, nil)
+      end
+      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/'
+      api_path = api_path + module_api_name.to_s
+      api_path = api_path + '/'
+      api_path = api_path + external_field_value.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)
+      handler_instance.module_api_name = module_api_name
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+      # The method to update record using external id
+      # @param external_field_value [String] A String
+      # @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_using_external_id(external_field_value, module_api_name, request, header_instance=nil)
+      if !external_field_value.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: String', nil, nil)
+      end
+      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/'
+      api_path = api_path + module_api_name.to_s
+      api_path = api_path + '/'
+      api_path = api_path + external_field_value.to_s
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_PUT
+      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'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+      # The method to delete record using external id
+      # @param external_field_value [String] A String
+      # @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_using_external_id(external_field_value, module_api_name, param_instance=nil, header_instance=nil)
+      if !external_field_value.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: String', nil, nil)
+      end
+      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/'
+      api_path = api_path + module_api_name.to_s
+      api_path = api_path + '/'
+      api_path = api_path + external_field_value.to_s
+      handler_instance.api_path = api_path
+      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
+
     class GetRecordParam
       @@approved = Param.new('approved', 'com.zoho.crm.api.Record.GetRecordParam')
       def self.approved
@@ -650,6 +765,13 @@ module Record
       end
     end
 
+    class CreateRecordsHeader
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.CreateRecordsHeader')
+      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
@@ -737,6 +859,10 @@ module Record
       def self.per_page
         @@per_page
       end
+      @@fields = Param.new('fields', 'com.zoho.crm.api.Record.SearchRecordsParam')
+      def self.fields
+        @@fields
+      end
     end
 
     class SearchRecordsHeader
@@ -753,5 +879,76 @@ module Record
       end
     end
 
+    class GetRecordUsingExternalIDParam
+      @@approved = Param.new('approved', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
+      def self.approved
+        @@approved
+      end
+      @@converted = Param.new('converted', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
+      def self.converted
+        @@converted
+      end
+      @@cvid = Param.new('cvid', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
+      def self.cvid
+        @@cvid
+      end
+      @@uid = Param.new('uid', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
+      def self.uid
+        @@uid
+      end
+      @@fields = Param.new('fields', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
+      def self.fields
+        @@fields
+      end
+      @@startDateTime = Param.new('startDateTime', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
+      def self.startDateTime
+        @@startDateTime
+      end
+      @@endDateTime = Param.new('endDateTime', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
+      def self.endDateTime
+        @@endDateTime
+      end
+      @@territory_id = Param.new('territory_id', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
+      def self.territory_id
+        @@territory_id
+      end
+      @@include_child = Param.new('include_child', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam')
+      def self.include_child
+        @@include_child
+      end
+    end
+
+    class GetRecordUsingExternalIDHeader
+      @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDHeader')
+      def self.If_modified_since
+        @@If_modified_since
+      end
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDHeader')
+      def self.X_external
+        @@X_external
+      end
+    end
+
+    class UpdateRecordUsingExternalIDHeader
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.UpdateRecordUsingExternalIDHeader')
+      def self.X_external
+        @@X_external
+      end
+    end
+
+    class DeleteRecordUsingExternalIDParam
+      @@wf_trigger = Param.new('wf_trigger', 'com.zoho.crm.api.Record.DeleteRecordUsingExternalIDParam')
+      def self.wf_trigger
+        @@wf_trigger
+      end
+    end
+
+    class DeleteRecordUsingExternalIDHeader
+      @@X_external = Header.new('X-EXTERNAL', 'com.zoho.crm.api.Record.DeleteRecordUsingExternalIDHeader')
+      def self.X_external
+        @@X_external
+      end
+    end
+
   end
 end