ZCRMSDK 2.0.0 → 3.0.1

data/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.rb

@@ -0,0 +1,61 @@
+require_relative '../param'
+require_relative '../parameter_map'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module AssignmentRules
+  class AssignmentRulesOperations
+
+    # Creates an instance of AssignmentRulesOperations
+    def initialize
+    end
+
+      # The method to get assignment rules
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_assignment_rules
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2.1/settings/automation/assignment_rules'
+      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 assignment rule
+      # @param rule_id [Integer] A Integer
+      # @param param_instance [ParameterMap] An instance of ParameterMap
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_assignment_rule(rule_id, param_instance=nil)
+      if !rule_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: rule_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.1/settings/automation/assignment_rules/'
+      api_path = api_path + rule_id.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
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+    class GetAssignmentRuleParam
+      @@module_1 = Param.new('module', 'com.zoho.crm.api.AssignmentRules.GetAssignmentRuleParam')
+      def self.module_1
+        @@module_1
+      end
+    end
+
+  end
+end

data/src/com/zoho/crm/api/assignment_rules/default_user.rb

@@ -0,0 +1,80 @@
+require_relative '../util/model'
+
+module AssignmentRules
+  class DefaultUser
+    include Util::Model
+
+    # Creates an instance of DefaultUser
+    def initialize
+      @name = nil
+      @id = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the name
+      # @return A String value
+
+    def name
+      @name
+    end
+
+      # The method to set the value to name
+      # @param name [String] A String
+
+    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 get the id
+      # @return A String value
+
+    def id
+      @id
+    end
+
+      # The method to set the value to id
+      # @param id [String] A String
+
+    def id=(id)
+      if id!=nil and !id.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: String', nil, nil)
+      end
+      @id = id
+      @key_modified['id'] = 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/assignment_rules/response_handler.rb

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

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

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

@@ -15,10 +15,12 @@ module Attachments
       @size = nil
       @parent_id = nil
       @editable = nil
+      @sharing_permission = nil
       @file_id = nil
       @type = nil
       @se_module = nil
       @modified_by = nil
+      @attachment_type = nil
       @state = nil
       @id = nil
       @created_by = nil
@@ -154,6 +156,24 @@ module Attachments
       @key_modified['$editable'] = 1
     end
 
+      # The method to get the sharing_permission
+      # @return A String value
+
+    def sharing_permission
+      @sharing_permission
+    end
+
+      # The method to set the value to sharing_permission
+      # @param sharing_permission [String] A String
+
+    def sharing_permission=(sharing_permission)
+      if sharing_permission!=nil and !sharing_permission.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sharing_permission EXPECTED TYPE: String', nil, nil)
+      end
+      @sharing_permission = sharing_permission
+      @key_modified['$sharing_permission'] = 1
+    end
+
       # The method to get the file_id
       # @return A String value
 
@@ -226,6 +246,24 @@ module Attachments
       @key_modified['Modified_By'] = 1
     end
 
+      # The method to get the attachment_type
+      # @return A Integer value
+
+    def attachment_type
+      @attachment_type
+    end
+
+      # The method to set the value to attachment_type
+      # @param attachment_type [Integer] A Integer
+
+    def attachment_type=(attachment_type)
+      if attachment_type!=nil and !attachment_type.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: attachment_type EXPECTED TYPE: Integer', nil, nil)
+      end
+      @attachment_type = attachment_type
+      @key_modified['$attachment_type'] = 1
+    end
+
       # The method to get the state
       # @return A String value
 
@@ -245,18 +283,18 @@ module Attachments
     end
 
       # The method to get the id
-      # @return A Integer value
+      # @return A String value
 
     def id
       @id
     end
 
       # The method to set the value to id
-      # @param id [Integer] A Integer
+      # @param id [String] A String
 
     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)
+      if id!=nil and !id.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: String', nil, nil)
       end
       @id = id
       @key_modified['id'] = 1

data/src/com/zoho/crm/api/attachments/attachments_operations.rb

@@ -32,7 +32,7 @@ module Attachments
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + @module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + @record_id.to_s
@@ -55,7 +55,7 @@ module Attachments
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + @module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + @record_id.to_s
@@ -78,7 +78,7 @@ module Attachments
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + @module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + @record_id.to_s
@@ -101,7 +101,7 @@ module Attachments
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + @module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + @record_id.to_s
@@ -126,7 +126,7 @@ module Attachments
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + @module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + @record_id.to_s
@@ -150,7 +150,7 @@ module Attachments
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + @module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + @record_id.to_s

data/src/com/zoho/crm/api/blue_print/blue_print_operations.rb

@@ -26,7 +26,7 @@ module BluePrint
     def get_blueprint
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + @module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + @record_id.to_s
@@ -48,7 +48,7 @@ module BluePrint
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + @module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + @record_id.to_s

data/src/com/zoho/crm/api/blue_print/escalation.rb

@@ -0,0 +1,80 @@
+require_relative '../util/model'
+
+module BluePrint
+  class Escalation
+    include Util::Model
+
+    # Creates an instance of Escalation
+    def initialize
+      @days = nil
+      @status = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the days
+      # @return A Integer value
+
+    def days
+      @days
+    end
+
+      # The method to set the value to days
+      # @param days [Integer] A Integer
+
+    def days=(days)
+      if days!=nil and !days.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: days EXPECTED TYPE: Integer', nil, nil)
+      end
+      @days = days
+      @key_modified['days'] = 1
+    end
+
+      # The method to get the status
+      # @return A String value
+
+    def status
+      @status
+    end
+
+      # The method to set the value to status
+      # @param status [String] A String
+
+    def status=(status)
+      if status!=nil and !status.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: String', nil, nil)
+      end
+      @status = status
+      @key_modified['status'] = 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