ZOHOCRMSDK2_0 1.0.0 → 5.0.0

data/src/com/zoho/crm/api/territories/territories_operations.rb

@@ -3,45 +3,47 @@ require_relative '../util/api_response'
 require_relative '../util/common_api_handler'
 require_relative '../util/constants'
 
-module Territories
-  class TerritoriesOperations
+module ZOHOCRMSDK
+  module Territories
+    class TerritoriesOperations
 
-    # Creates an instance of TerritoriesOperations
-    def initialize
-    end
+      # Creates an instance of TerritoriesOperations
+      def initialize
+      end
 
-      # The method to get territories
-      # @return An instance of APIResponse
-    # @raise SDKException
-    def get_territories
-      handler_instance = Handler::CommonAPIHandler.new
-      api_path = ''
-      api_path = api_path + '/crm/v2/settings/territories'
-      handler_instance.api_path = api_path
-      handler_instance.http_method = Constants::REQUEST_METHOD_GET
-      handler_instance.category_method = 'READ'
-      require_relative 'response_handler'
-      handler_instance.api_call(ResponseHandler.name, 'application/json')
-    end
+        # The method to get territories
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_territories
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/crm/v2/settings/territories'
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_GET
+        handler_instance.category_method = 'READ'
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
+      end
 
-      # The method to get territory
-      # @param id [Integer] A Integer
-      # @return An instance of APIResponse
-    # @raise SDKException
-    def get_territory(id)
-      if !id.is_a? Integer
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+        # The method to get territory
+        # @param id [Integer] A Integer
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_territory(id)
+        if !id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/crm/v2/settings/territories/'
+        api_path = api_path + id.to_s
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_GET
+        handler_instance.category_method = 'READ'
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
       end
-      handler_instance = Handler::CommonAPIHandler.new
-      api_path = ''
-      api_path = api_path + '/crm/v2/settings/territories/'
-      api_path = api_path + id.to_s
-      handler_instance.api_path = api_path
-      handler_instance.http_method = Constants::REQUEST_METHOD_GET
-      handler_instance.category_method = 'READ'
-      require_relative 'response_handler'
-      handler_instance.api_call(ResponseHandler.name, 'application/json')
-    end
 
+    end
   end
 end

data/src/com/zoho/crm/api/territories/territory.rb

@@ -2,233 +2,235 @@ require_relative '../custom_views/criteria'
 require_relative '../users/user'
 require_relative '../util/model'
 
-module Territories
-  class Territory
-    include Util::Model
-
-    # Creates an instance of Territory
-    def initialize
-      @created_time = nil
-      @modified_time = nil
-      @manager = nil
-      @parent_id = nil
-      @criteria = nil
-      @name = nil
-      @modified_by = nil
-      @description = nil
-      @id = nil
-      @created_by = nil
-      @key_modified = Hash.new
-    end
-
-      # The method to get the created_time
-      # @return An instance of DateTime
-
-    def created_time
-      @created_time
-    end
+module ZOHOCRMSDK
+  module Territories
+    class Territory
+      include Util::Model
+
+      # Creates an instance of Territory
+      def initialize
+        @created_time = nil
+        @modified_time = nil
+        @manager = nil
+        @parent_id = nil
+        @criteria = nil
+        @name = nil
+        @modified_by = nil
+        @description = nil
+        @id = nil
+        @created_by = nil
+        @key_modified = Hash.new
+      end
 
-      # The method to set the value to created_time
-      # @param created_time [DateTime] An instance of DateTime
+        # The method to get the created_time
+        # @return An instance of DateTime
 
-    def created_time=(created_time)
-      if created_time!=nil and !created_time.is_a? DateTime
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: DateTime', nil, nil)
+      def created_time
+        @created_time
       end
-      @created_time = created_time
-      @key_modified['created_time'] = 1
-    end
 
-      # The method to get the modified_time
-      # @return An instance of DateTime
+        # The method to set the value to created_time
+        # @param created_time [DateTime] An instance of DateTime
 
-    def modified_time
-      @modified_time
-    end
+      def created_time=(created_time)
+        if created_time!=nil and !created_time.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: DateTime', nil, nil)
+        end
+        @created_time = created_time
+        @key_modified['created_time'] = 1
+      end
 
-      # The method to set the value to modified_time
-      # @param modified_time [DateTime] An instance of DateTime
+        # The method to get the modified_time
+        # @return An instance of DateTime
 
-    def modified_time=(modified_time)
-      if modified_time!=nil and !modified_time.is_a? DateTime
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: DateTime', nil, nil)
+      def modified_time
+        @modified_time
       end
-      @modified_time = modified_time
-      @key_modified['modified_time'] = 1
-    end
 
-      # The method to get the manager
-      # @return An instance of Users::User
+        # The method to set the value to modified_time
+        # @param modified_time [DateTime] An instance of DateTime
 
-    def manager
-      @manager
-    end
+      def modified_time=(modified_time)
+        if modified_time!=nil and !modified_time.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: DateTime', nil, nil)
+        end
+        @modified_time = modified_time
+        @key_modified['modified_time'] = 1
+      end
 
-      # The method to set the value to manager
-      # @param manager [Users::User] An instance of Users::User
+        # The method to get the manager
+        # @return An instance of Users::User
 
-    def manager=(manager)
-      if manager!=nil and !manager.is_a? Users::User
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: manager EXPECTED TYPE: User', nil, nil)
+      def manager
+        @manager
       end
-      @manager = manager
-      @key_modified['manager'] = 1
-    end
 
-      # The method to get the parent_id
-      # @return A String value
+        # The method to set the value to manager
+        # @param manager [Users::User] An instance of Users::User
 
-    def parent_id
-      @parent_id
-    end
+      def manager=(manager)
+        if manager!=nil and !manager.is_a? Users::User
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: manager EXPECTED TYPE: User', nil, nil)
+        end
+        @manager = manager
+        @key_modified['manager'] = 1
+      end
 
-      # The method to set the value to parent_id
-      # @param parent_id [String] A String
+        # The method to get the parent_id
+        # @return A String value
 
-    def parent_id=(parent_id)
-      if parent_id!=nil and !parent_id.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: parent_id EXPECTED TYPE: String', nil, nil)
+      def parent_id
+        @parent_id
       end
-      @parent_id = parent_id
-      @key_modified['parent_id'] = 1
-    end
 
-      # The method to get the criteria
-      # @return An instance of CustomViews::Criteria
+        # The method to set the value to parent_id
+        # @param parent_id [String] A String
 
-    def criteria
-      @criteria
-    end
+      def parent_id=(parent_id)
+        if parent_id!=nil and !parent_id.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: parent_id EXPECTED TYPE: String', nil, nil)
+        end
+        @parent_id = parent_id
+        @key_modified['parent_id'] = 1
+      end
 
-      # The method to set the value to criteria
-      # @param criteria [CustomViews::Criteria] An instance of CustomViews::Criteria
+        # The method to get the criteria
+        # @return An instance of CustomViews::Criteria
 
-    def criteria=(criteria)
-      if criteria!=nil and !criteria.is_a? CustomViews::Criteria
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', nil, nil)
+      def criteria
+        @criteria
       end
-      @criteria = criteria
-      @key_modified['criteria'] = 1
-    end
 
-      # The method to get the name
-      # @return A String value
+        # The method to set the value to criteria
+        # @param criteria [CustomViews::Criteria] An instance of CustomViews::Criteria
 
-    def name
-      @name
-    end
+      def criteria=(criteria)
+        if criteria!=nil and !criteria.is_a? CustomViews::Criteria
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', nil, nil)
+        end
+        @criteria = criteria
+        @key_modified['criteria'] = 1
+      end
 
-      # The method to set the value to name
-      # @param name [String] A String
+        # The method to get the name
+        # @return A String value
 
-    def name=(name)
-      if name!=nil and !name.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
+      def name
+        @name
       end
-      @name = name
-      @key_modified['name'] = 1
-    end
 
-      # The method to get the modified_by
-      # @return An instance of Users::User
+        # The method to set the value to name
+        # @param name [String] A String
 
-    def modified_by
-      @modified_by
-    end
+      def name=(name)
+        if name!=nil and !name.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
+        end
+        @name = name
+        @key_modified['name'] = 1
+      end
 
-      # The method to set the value to modified_by
-      # @param modified_by [Users::User] An instance of Users::User
+        # The method to get the modified_by
+        # @return An instance of Users::User
 
-    def modified_by=(modified_by)
-      if modified_by!=nil and !modified_by.is_a? Users::User
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', nil, nil)
+      def modified_by
+        @modified_by
       end
-      @modified_by = modified_by
-      @key_modified['modified_by'] = 1
-    end
 
-      # The method to get the description
-      # @return A String value
+        # The method to set the value to modified_by
+        # @param modified_by [Users::User] An instance of Users::User
 
-    def description
-      @description
-    end
+      def modified_by=(modified_by)
+        if modified_by!=nil and !modified_by.is_a? Users::User
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', nil, nil)
+        end
+        @modified_by = modified_by
+        @key_modified['modified_by'] = 1
+      end
 
-      # The method to set the value to description
-      # @param description [String] A String
+        # The method to get the description
+        # @return A String value
 
-    def description=(description)
-      if description!=nil and !description.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: description EXPECTED TYPE: String', nil, nil)
+      def description
+        @description
       end
-      @description = description
-      @key_modified['description'] = 1
-    end
 
-      # The method to get the id
-      # @return A Integer value
+        # The method to set the value to description
+        # @param description [String] A String
 
-    def id
-      @id
-    end
+      def description=(description)
+        if description!=nil and !description.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: description EXPECTED TYPE: String', nil, nil)
+        end
+        @description = description
+        @key_modified['description'] = 1
+      end
 
-      # The method to set the value to id
-      # @param id [Integer] A Integer
+        # The method to get the id
+        # @return A Integer value
 
-    def id=(id)
-      if id!=nil and !id.is_a? Integer
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+      def id
+        @id
       end
-      @id = id
-      @key_modified['id'] = 1
-    end
 
-      # The method to get the created_by
-      # @return An instance of Users::User
+        # The method to set the value to id
+        # @param id [Integer] A Integer
 
-    def created_by
-      @created_by
-    end
+      def id=(id)
+        if id!=nil and !id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+        end
+        @id = id
+        @key_modified['id'] = 1
+      end
 
-      # The method to set the value to created_by
-      # @param created_by [Users::User] An instance of Users::User
+        # The method to get the created_by
+        # @return An instance of Users::User
 
-    def created_by=(created_by)
-      if created_by!=nil and !created_by.is_a? Users::User
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', nil, nil)
+      def created_by
+        @created_by
       end
-      @created_by = created_by
-      @key_modified['created_by'] = 1
-    end
 
-      # The method to check if the user has modified the given key
-      # @param key [String] A String
-      # @return A Integer value
+        # The method to set the value to created_by
+        # @param created_by [Users::User] An instance of Users::User
 
-    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]
+      def created_by=(created_by)
+        if created_by!=nil and !created_by.is_a? Users::User
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', nil, nil)
+        end
+        @created_by = created_by
+        @key_modified['created_by'] = 1
       end
 
-      nil
-    end
+        # The method to check if the user has modified the given key
+        # @param key [String] A String
+        # @return A Integer value
 
-      # The method to mark the given key as modified
-      # @param key [String] A String
-      # @param modification [Integer] A Integer
+      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
 
-    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)
+        nil
       end
-      if modification!=nil and !modification.is_a? Integer
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+
+        # 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
-      @key_modified[key] = modification
-    end
 
+    end
   end
 end

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

@@ -1,27 +1,29 @@
 require_relative '../../api/logger/sdk_logger'
-# This class represents the CRM user email.
-class UserSignature
-  attr_reader :email
+module ZOHOCRMSDK
+  # This class represents the CRM user email.
+  class UserSignature
+    attr_reader :email
 
-  # Creates an UserSignature class instance with the specified user email.
-  # @param email [String] A String containing the CRM user email
-  # @raise SDKException
-  def initialize(email)
-    require_relative 'util/constants'
+    # Creates an UserSignature class instance with the specified user email.
+    # @param email [String] A String containing the CRM user email
+    # @raise SDKException
+    def initialize(email)
+      require_relative 'util/constants'
 
-    error = {}
+      error = {}
 
-    if (email.match Constants::EMAIL_REGEX).nil?
-      error[Constants::ERROR_HASH_FIELD] = Constants::EMAIL
+      if (email.match Constants::EMAIL_REGEX).nil?
+        error[Constants::ERROR_HASH_FIELD] = Constants::EMAIL
 
-      error[Constants::ERROR_HASH_EXPECTED_TYPE] = Constants::EMAIL
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = Constants::EMAIL
 
-      ex = SDKException.new(Constants::USER_SIGNATURE_ERROR, nil, error, nil)
+        ex = SDKException.new(Constants::USER_SIGNATURE_ERROR, nil, error, nil)
 
-      raise ex
+        raise ex
 
-    end
+      end
 
-    @email = email
+      @email = email
+    end
   end
-end
+end

data/src/com/zoho/crm/api/users/action_handler.rb

@@ -1,10 +1,12 @@
-module Users
-  module ActionHandler
+module ZOHOCRMSDK
+  module Users
+    module ActionHandler
 
-    # Creates an instance of ActionHandler
-    def initialize
-    end
+      # Creates an instance of ActionHandler
+      def initialize
+      end
 
 
+    end
   end
 end

data/src/com/zoho/crm/api/users/action_response.rb

@@ -1,10 +1,12 @@
-module Users
-  module ActionResponse
+module ZOHOCRMSDK
+  module Users
+    module ActionResponse
 
-    # Creates an instance of ActionResponse
-    def initialize
-    end
+      # Creates an instance of ActionResponse
+      def initialize
+      end
 
 
+    end
   end
 end