ZOHOCRMSDK2_0 1.0.0 → 2.0.0

data/src/com/zoho/api/authenticator/store/token_store.rb

@@ -22,5 +22,12 @@ module Store
     def delete_token(token); end
 
     def delete_tokens; end
+
+       # This method is used to get the user token details.
+    # @param user A UserSignature class instance.
+    # @param id A String containing id
+    # @return A Token class instance representing the user token details.
+    # @raise SDKException
+    def get_token_by_id(id, token); end
   end
 end

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

@@ -4,15 +4,16 @@ require 'logger'
 
 module SDKLog
   class Log
-    attr_accessor :level, :path
-    def initialize(level, path)
+    attr_reader :level , :path
+    def initialize(level,path)
       @level = level
       @path = path
     end
 
-    def self.initialize(level, path)
+    def self.initialize(level:, path:nil)
       Log.new(level, path)
     end
+   
   end
 
   class SDKLogger
@@ -22,15 +23,23 @@ module SDKLog
     @@logger = nil
 
     def self.initialize(log)
-      if(log.level != Levels::OFF) && !log.path.nil? && log.path.length > 0 
-        File.new(log.path, 'w') unless File.exist? log.path if log.path != nil
-        sdk_logger = WEBrick::BasicLog.new(log.path, @@log_levels_precedence[log.level])
-      elsif !log.level.nil? and log.level == Levels::OFF
-        sdk_logger = WEBrick::BasicLog.new(nil, @@log_levels_precedence[log.level])
+
+      if !log.level.nil? && log.level != Levels::OFF && !log.path.nil? && log.path.length > 0 
+        if @@log_levels_precedence.key? log.level
+          File.new(log.path, 'w') unless File.exist? log.path if log.path != nil
+          sdk_logger = WEBrick::BasicLog.new(log.path, @@log_levels_precedence[log.level])
+        end
+      end
+
+      if !log.level.nil? && log.path.nil?
+        if  @@log_levels_precedence.key? log.level
+          sdk_logger = WEBrick::BasicLog.new(nil, @@log_levels_precedence[log.level])
+        end
       end
+
       @@logger = sdk_logger
     rescue StandardError => e
-      raise SDKException.new(nil, Constants::SDK_LOGGER_INITIALIZE, nil, e)
+      raise SDKException.new(nil, Constants::LOGGER_INITIALIZATION_ERROR, nil, e)
     end
 
     def self.info(message)
@@ -50,6 +59,7 @@ 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/contact_roles/api_exception.rb

@@ -5,11 +5,15 @@ module ContactRoles
   require_relative 'response_handler'
   require_relative 'action_response'
   require_relative 'action_handler'
+  require_relative 'record_response_handler'
+  require_relative 'record_action_handler'
   class APIException
     include Util::Model
     include ResponseHandler
     include ActionResponse
     include ActionHandler
+    include RecordResponseHandler
+    include RecordActionHandler
 
     # Creates an instance of APIException
     def initialize

data/src/com/zoho/crm/api/contact_roles/contact_role_wrapper.rb

@@ -0,0 +1,61 @@
+require_relative '../util/model'
+
+module ContactRoles
+  class ContactRoleWrapper
+    include Util::Model
+
+    # Creates an instance of ContactRoleWrapper
+    def initialize
+      @contact_role = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the contact_role
+      # @return A String value
+
+    def contact_role
+      @contact_role
+    end
+
+      # The method to set the value to contact_role
+      # @param contact_role [String] A String
+
+    def contact_role=(contact_role)
+      if contact_role!=nil and !contact_role.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: contact_role EXPECTED TYPE: String', nil, nil)
+      end
+      @contact_role = contact_role
+      @key_modified['Contact_Role'] = 1
+    end
+
+      # The method to check if the user has modified the given key
+      # @param key [String] A String
+      # @return A Integer value
+
+    def is_key_modified(key)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if @key_modified.key?(key)
+        return @key_modified[key]
+      end
+
+      nil
+    end
+
+      # The method to mark the given key as modified
+      # @param key [String] A String
+      # @param modification [Integer] A Integer
+
+    def set_key_modified(key, modification)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if modification!=nil and !modification.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+      end
+      @key_modified[key] = modification
+    end
+
+  end
+end

data/src/com/zoho/crm/api/contact_roles/contact_roles_operations.rb

@@ -3,6 +3,7 @@ require_relative '../parameter_map'
 require_relative '../exception/sdk_exception'
 require_relative '../util/api_response'
 require_relative '../util/common_api_handler'
+require_relative '../util/utility'
 require_relative '../util/constants'
 
 module ContactRoles
@@ -150,6 +151,116 @@ module ContactRoles
       handler_instance.api_call(ActionHandler.name, 'application/json')
     end
 
+      # The method to get all contact roles of deal
+      # @param deal_id [Integer] A Integer
+      # @param param_instance [ParameterMap] An instance of ParameterMap
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_all_contact_roles_of_deal(deal_id, param_instance=nil)
+      if !deal_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: deal_id EXPECTED TYPE: Integer', 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/Deals/'
+      api_path = api_path + deal_id.to_s
+      api_path = api_path + '/Contact_Roles'
+      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("Contacts")
+      handler_instance.module_api_name = "Contacts"
+      require_relative 'record_response_handler'
+      handler_instance.api_call(RecordResponseHandler.name, 'application/json')
+    end
+
+      # The method to get contact role of deal
+      # @param contact_id [Integer] A Integer
+      # @param deal_id [Integer] A Integer
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_contact_role_of_deal(contact_id, deal_id)
+      if !contact_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: contact_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      if !deal_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: deal_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/Deals/'
+      api_path = api_path + deal_id.to_s
+      api_path = api_path + '/Contact_Roles/'
+      api_path = api_path + contact_id.to_s
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_GET
+      handler_instance.category_method = 'READ'
+      Util::Utility.get_fields("Contacts")
+      handler_instance.module_api_name = "Contacts"
+      require_relative 'record_response_handler'
+      handler_instance.api_call(RecordResponseHandler.name, 'application/json')
+    end
+
+      # The method to add contact role to deal
+      # @param contact_id [Integer] A Integer
+      # @param deal_id [Integer] A Integer
+      # @param request [RecordBodyWrapper] An instance of RecordBodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def add_contact_role_to_deal(contact_id, deal_id, request)
+      if !contact_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: contact_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      if !deal_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: deal_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      if request!=nil and !request.is_a? RecordBodyWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: RecordBodyWrapper', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/Deals/'
+      api_path = api_path + deal_id.to_s
+      api_path = api_path + '/Contact_Roles/'
+      api_path = api_path + contact_id.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
+      require_relative 'record_action_handler'
+      handler_instance.api_call(RecordActionHandler.name, 'application/json')
+    end
+
+      # The method to remove contact role from deal
+      # @param contact_id [Integer] A Integer
+      # @param deal_id [Integer] A Integer
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def remove_contact_role_from_deal(contact_id, deal_id)
+      if !contact_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: contact_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      if !deal_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: deal_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/Deals/'
+      api_path = api_path + deal_id.to_s
+      api_path = api_path + '/Contact_Roles/'
+      api_path = api_path + contact_id.to_s
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
+      handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
+      require_relative 'record_action_handler'
+      handler_instance.api_call(RecordActionHandler.name, 'application/json')
+    end
+
     class DeleteContactRolesParam
       @@ids = Param.new('ids', 'com.zoho.crm.api.ContactRoles.DeleteContactRolesParam')
       def self.ids
@@ -157,5 +268,12 @@ module ContactRoles
       end
     end
 
+    class GetAllContactRolesOfDealParam
+      @@ids = Param.new('ids', 'com.zoho.crm.api.ContactRoles.GetAllContactRolesOfDealParam')
+      def self.ids
+        @@ids
+      end
+    end
+
   end
 end

data/src/com/zoho/crm/api/contact_roles/record_action_handler.rb

@@ -0,0 +1,10 @@
+module ContactRoles
+  module RecordActionHandler
+
+    # Creates an instance of RecordActionHandler
+    def initialize
+    end
+
+
+  end
+end

data/src/com/zoho/crm/api/contact_roles/record_action_wrapper.rb

@@ -0,0 +1,63 @@
+require_relative '../util/model'
+
+module ContactRoles
+  require_relative 'record_action_handler'
+  class RecordActionWrapper
+    include Util::Model
+    include RecordActionHandler
+
+    # Creates an instance of RecordActionWrapper
+    def initialize
+      @data = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the data
+      # @return An instance of Array
+
+    def data
+      @data
+    end
+
+      # The method to set the value to data
+      # @param data [Array] An instance of Array
+
+    def data=(data)
+      if data!=nil and !data.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: Array', nil, nil)
+      end
+      @data = data
+      @key_modified['data'] = 1
+    end
+
+      # The method to check if the user has modified the given key
+      # @param key [String] A String
+      # @return A Integer value
+
+    def is_key_modified(key)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if @key_modified.key?(key)
+        return @key_modified[key]
+      end
+
+      nil
+    end
+
+      # The method to mark the given key as modified
+      # @param key [String] A String
+      # @param modification [Integer] A Integer
+
+    def set_key_modified(key, modification)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if modification!=nil and !modification.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+      end
+      @key_modified[key] = modification
+    end
+
+  end
+end

data/src/com/zoho/crm/api/contact_roles/record_body_wrapper.rb

@@ -0,0 +1,61 @@
+require_relative '../util/model'
+
+module ContactRoles
+  class RecordBodyWrapper
+    include Util::Model
+
+    # Creates an instance of RecordBodyWrapper
+    def initialize
+      @data = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the data
+      # @return An instance of Array
+
+    def data
+      @data
+    end
+
+      # The method to set the value to data
+      # @param data [Array] An instance of Array
+
+    def data=(data)
+      if data!=nil and !data.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: Array', nil, nil)
+      end
+      @data = data
+      @key_modified['data'] = 1
+    end
+
+      # The method to check if the user has modified the given key
+      # @param key [String] A String
+      # @return A Integer value
+
+    def is_key_modified(key)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if @key_modified.key?(key)
+        return @key_modified[key]
+      end
+
+      nil
+    end
+
+      # The method to mark the given key as modified
+      # @param key [String] A String
+      # @param modification [Integer] A Integer
+
+    def set_key_modified(key, modification)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if modification!=nil and !modification.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+      end
+      @key_modified[key] = modification
+    end
+
+  end
+end

data/src/com/zoho/crm/api/contact_roles/record_response_handler.rb

@@ -0,0 +1,10 @@
+module ContactRoles
+  module RecordResponseHandler
+
+    # Creates an instance of RecordResponseHandler
+    def initialize
+    end
+
+
+  end
+end

data/src/com/zoho/crm/api/contact_roles/record_response_wrapper.rb

@@ -0,0 +1,84 @@
+require_relative '../record/info'
+require_relative '../record/record'
+require_relative '../util/model'
+
+module ContactRoles
+  require_relative 'record_response_handler'
+  class RecordResponseWrapper
+    include Util::Model
+    include RecordResponseHandler
+
+    # Creates an instance of RecordResponseWrapper
+    def initialize
+      @data = nil
+      @info = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the data
+      # @return An instance of Array
+
+    def data
+      @data
+    end
+
+      # The method to set the value to data
+      # @param data [Array] An instance of Array
+
+    def data=(data)
+      if data!=nil and !data.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: Array', nil, nil)
+      end
+      @data = data
+      @key_modified['data'] = 1
+    end
+
+      # The method to get the info
+      # @return An instance of Record::Info
+
+    def info
+      @info
+    end
+
+      # The method to set the value to info
+      # @param info [Record::Info] An instance of Record::Info
+
+    def info=(info)
+      if info!=nil and !info.is_a? Record::Info
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', nil, nil)
+      end
+      @info = info
+      @key_modified['info'] = 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