ZOHOCRMSDK2_0 1.0.0 → 5.0.0

data/src/com/zoho/crm/api/roles/response_wrapper.rb

@@ -1,63 +1,65 @@
 require_relative '../util/model'
 
-module Roles
-  require_relative 'response_handler'
-  class ResponseWrapper
-    include Util::Model
-    include ResponseHandler
-
-    # Creates an instance of ResponseWrapper
-    def initialize
-      @roles = nil
-      @key_modified = Hash.new
-    end
-
-      # The method to get the roles
-      # @return An instance of Array
+module ZOHOCRMSDK
+  module Roles
+    require_relative 'response_handler'
+    class ResponseWrapper
+      include Util::Model
+      include ResponseHandler
 
-    def roles
-      @roles
-    end
+      # Creates an instance of ResponseWrapper
+      def initialize
+        @roles = nil
+        @key_modified = Hash.new
+      end
 
-      # The method to set the value to roles
-      # @param roles [Array] An instance of Array
+        # The method to get the roles
+        # @return An instance of Array
 
-    def roles=(roles)
-      if roles!=nil and !roles.is_a? Array
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: roles EXPECTED TYPE: Array', nil, nil)
+      def roles
+        @roles
       end
-      @roles = roles
-      @key_modified['roles'] = 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 roles
+        # @param roles [Array] An instance of Array
 
-    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 roles=(roles)
+        if roles!=nil and !roles.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: roles EXPECTED TYPE: Array', nil, nil)
+        end
+        @roles = roles
+        @key_modified['roles'] = 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/roles/role.rb

@@ -1,195 +1,197 @@
 require_relative '../users/user'
 require_relative '../util/model'
 
-module Roles
-  class Role
-    include Util::Model
-
-    # Creates an instance of Role
-    def initialize
-      @display_label = nil
-      @forecast_manager = nil
-      @share_with_peers = nil
-      @name = nil
-      @description = nil
-      @id = nil
-      @reporting_to = nil
-      @admin_user = nil
-      @key_modified = Hash.new
-    end
-
-      # The method to get the display_label
-      # @return A String value
-
-    def display_label
-      @display_label
-    end
+module ZOHOCRMSDK
+  module Roles
+    class Role
+      include Util::Model
+
+      # Creates an instance of Role
+      def initialize
+        @display_label = nil
+        @forecast_manager = nil
+        @share_with_peers = nil
+        @name = nil
+        @description = nil
+        @id = nil
+        @reporting_to = nil
+        @admin_user = nil
+        @key_modified = Hash.new
+      end
 
-      # The method to set the value to display_label
-      # @param display_label [String] A String
+        # The method to get the display_label
+        # @return A String value
 
-    def display_label=(display_label)
-      if display_label!=nil and !display_label.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
+      def display_label
+        @display_label
       end
-      @display_label = display_label
-      @key_modified['display_label'] = 1
-    end
 
-      # The method to get the forecast_manager
-      # @return An instance of Users::User
+        # The method to set the value to display_label
+        # @param display_label [String] A String
 
-    def forecast_manager
-      @forecast_manager
-    end
+      def display_label=(display_label)
+        if display_label!=nil and !display_label.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
+        end
+        @display_label = display_label
+        @key_modified['display_label'] = 1
+      end
 
-      # The method to set the value to forecast_manager
-      # @param forecast_manager [Users::User] An instance of Users::User
+        # The method to get the forecast_manager
+        # @return An instance of Users::User
 
-    def forecast_manager=(forecast_manager)
-      if forecast_manager!=nil and !forecast_manager.is_a? Users::User
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: forecast_manager EXPECTED TYPE: User', nil, nil)
+      def forecast_manager
+        @forecast_manager
       end
-      @forecast_manager = forecast_manager
-      @key_modified['forecast_manager'] = 1
-    end
 
-      # The method to get the share_with_peers
-      # @return A Boolean value
+        # The method to set the value to forecast_manager
+        # @param forecast_manager [Users::User] An instance of Users::User
 
-    def share_with_peers
-      @share_with_peers
-    end
+      def forecast_manager=(forecast_manager)
+        if forecast_manager!=nil and !forecast_manager.is_a? Users::User
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: forecast_manager EXPECTED TYPE: User', nil, nil)
+        end
+        @forecast_manager = forecast_manager
+        @key_modified['forecast_manager'] = 1
+      end
 
-      # The method to set the value to share_with_peers
-      # @param share_with_peers [Boolean] A Boolean
+        # The method to get the share_with_peers
+        # @return A Boolean value
 
-    def share_with_peers=(share_with_peers)
-      if share_with_peers!=nil and ! [true, false].include?share_with_peers
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: share_with_peers EXPECTED TYPE: Boolean', nil, nil)
+      def share_with_peers
+        @share_with_peers
       end
-      @share_with_peers = share_with_peers
-      @key_modified['share_with_peers'] = 1
-    end
 
-      # The method to get the name
-      # @return A String value
+        # The method to set the value to share_with_peers
+        # @param share_with_peers [Boolean] A Boolean
 
-    def name
-      @name
-    end
+      def share_with_peers=(share_with_peers)
+        if share_with_peers!=nil and ! [true, false].include?share_with_peers
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: share_with_peers EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @share_with_peers = share_with_peers
+        @key_modified['share_with_peers'] = 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 description
-      # @return A String value
+        # The method to set the value to name
+        # @param name [String] A String
 
-    def description
-      @description
-    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 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 reporting_to
-      # @return An instance of Users::User
+        # The method to set the value to id
+        # @param id [Integer] A Integer
 
-    def reporting_to
-      @reporting_to
-    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 reporting_to
-      # @param reporting_to [Users::User] An instance of Users::User
+        # The method to get the reporting_to
+        # @return An instance of Users::User
 
-    def reporting_to=(reporting_to)
-      if reporting_to!=nil and !reporting_to.is_a? Users::User
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: reporting_to EXPECTED TYPE: User', nil, nil)
+      def reporting_to
+        @reporting_to
       end
-      @reporting_to = reporting_to
-      @key_modified['reporting_to'] = 1
-    end
 
-      # The method to get the admin_user
-      # @return A Boolean value
+        # The method to set the value to reporting_to
+        # @param reporting_to [Users::User] An instance of Users::User
 
-    def admin_user
-      @admin_user
-    end
+      def reporting_to=(reporting_to)
+        if reporting_to!=nil and !reporting_to.is_a? Users::User
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: reporting_to EXPECTED TYPE: User', nil, nil)
+        end
+        @reporting_to = reporting_to
+        @key_modified['reporting_to'] = 1
+      end
 
-      # The method to set the value to admin_user
-      # @param admin_user [Boolean] A Boolean
+        # The method to get the admin_user
+        # @return A Boolean value
 
-    def admin_user=(admin_user)
-      if admin_user!=nil and ! [true, false].include?admin_user
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: admin_user EXPECTED TYPE: Boolean', nil, nil)
+      def admin_user
+        @admin_user
       end
-      @admin_user = admin_user
-      @key_modified['admin_user'] = 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 admin_user
+        # @param admin_user [Boolean] A Boolean
 
-    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 admin_user=(admin_user)
+        if admin_user!=nil and ! [true, false].include?admin_user
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: admin_user EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @admin_user = admin_user
+        @key_modified['admin_user'] = 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/roles/roles_operations.rb

@@ -3,45 +3,47 @@ require_relative '../util/api_response'
 require_relative '../util/common_api_handler'
 require_relative '../util/constants'
 
-module Roles
-  class RolesOperations
+module ZOHOCRMSDK
+  module Roles
+    class RolesOperations
 
-    # Creates an instance of RolesOperations
-    def initialize
-    end
+      # Creates an instance of RolesOperations
+      def initialize
+      end
 
-      # The method to get roles
-      # @return An instance of APIResponse
-    # @raise SDKException
-    def get_roles
-      handler_instance = Handler::CommonAPIHandler.new
-      api_path = ''
-      api_path = api_path + '/crm/v2/settings/roles'
-      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 roles
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_roles
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/crm/v2/settings/roles'
+        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 role
-      # @param id [Integer] A Integer
-      # @return An instance of APIResponse
-    # @raise SDKException
-    def get_role(id)
-      if !id.is_a? Integer
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+        # The method to get role
+        # @param id [Integer] A Integer
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_role(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/roles/'
+        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/roles/'
-      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/sdk_config.rb

@@ -1,78 +1,15 @@
-class SDKConfig
-  class Builder
-    def initialize
-      @auto_refresh_fields = false
-      @pick_list_validation = true
-      @open_timeout = 60
-      @read_timeout = 60
-      @write_timeout = 60
-      @keep_alive_timeout = 2
-    end
 
-    def auto_refresh_fields(auto_refresh_fields)
-      @auto_refresh_fields = auto_refresh_fields
-      self
-    end
+module ZOHOCRMSDK
+  class SDKConfig
+    attr_reader :auto_refresh_fields , :pick_list_validation ,:open_timeout ,:read_timeout ,:write_timeout ,:keep_alive_timeout
 
-    def pick_list_validation(pick_list_validation)
+    def initialize(auto_refresh_fields: false, pick_list_validation: true,open_timeout: 60,read_timeout: 60,write_timeout: 60,keep_alive_timeout: 2)
+      @auto_refresh_fields = auto_refresh_fields
       @pick_list_validation = pick_list_validation
-      self
-    end
-
-    def open_timeout(open_timeout)
       @open_timeout = open_timeout
-      self
-    end
-
-    def read_timeout(read_timeout)
       @read_timeout = read_timeout
-      self
-    end
-
-    def write_timeout(write_timeout)
       @write_timeout = write_timeout
-      self
-    end
-
-    def keep_alive_timeout(keep_alive_timeout)
       @keep_alive_timeout = keep_alive_timeout
-      self
-    end
-
-    def build
-      SDKConfig.new(@auto_refresh_fields, @pick_list_validation,@open_timeout,@read_timeout,@write_timeout,@keep_alive_timeout)
     end
   end
-  def initialize(auto_refresh_fields, pick_list_validation,open_timeout,read_timeout,write_timeout,keep_alive_timeout)
-    @auto_refresh_fields = auto_refresh_fields
-    @pick_list_validation = pick_list_validation
-    @open_timeout = open_timeout
-    @read_timeout = read_timeout
-    @write_timeout = write_timeout
-    @keep_alive_timeout = keep_alive_timeout
-  end
-
-  def auto_refresh_fields
-    @auto_refresh_fields
-  end
-
-  def pick_list_validation
-    @pick_list_validation
-  end
-  
-  def open_timeout
-    @open_timeout   
-  end
-
-  def read_timeout
-    @read_timeout 
-  end
-
-  def write_timeout
-    @write_timeout
-  end
-
-  def keep_alive_timeout
-    @keep_alive_timeout 
-  end
 end

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

@@ -1,10 +1,12 @@
-module ShareRecords
-  module ActionHandler
+module ZOHOCRMSDK
+  module ShareRecords
+    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/share_records/action_response.rb

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