ZCRMSDK 2.0.0 → 3.0.1

data/src/com/zoho/crm/api/custom_views/criteria.rb

@@ -1,3 +1,4 @@
+require_relative '../fields/field'
 require_relative '../util/choice'
 require_relative '../util/model'
 
@@ -34,18 +35,18 @@ module CustomViews
     end
 
       # The method to get the field
-      # @return A String value
+      # @return An instance of Fields::Field
 
     def field
       @field
     end
 
       # The method to set the value to field
-      # @param field [String] A String
+      # @param field [Fields::Field] An instance of Fields::Field
 
     def field=(field)
-      if field!=nil and !field.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: String', nil, nil)
+      if field!=nil and !field.is_a? Fields::Field
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', nil, nil)
       end
       @field = field
       @key_modified['field'] = 1

data/src/com/zoho/crm/api/custom_views/custom_view.rb

@@ -1,3 +1,5 @@
+require_relative '../fields/field'
+require_relative '../users/user'
 require_relative '../util/model'
 
 module CustomViews
@@ -10,17 +12,20 @@ module CustomViews
       @name = nil
       @system_name = nil
       @display_value = nil
-      @shared_type = nil
+      @access_type = nil
       @category = nil
       @sort_by = nil
       @sort_order = nil
       @favorite = nil
-      @offline = nil
       @default = nil
       @system_defined = nil
       @criteria = nil
-      @shared_details = nil
+      @shared_to = nil
       @fields = nil
+      @modified_time = nil
+      @modified_by = nil
+      @last_accessed_time = nil
+      @created_by = nil
       @key_modified = Hash.new
     end
 
@@ -96,22 +101,22 @@ module CustomViews
       @key_modified['display_value'] = 1
     end
 
-      # The method to get the shared_type
+      # The method to get the access_type
       # @return A String value
 
-    def shared_type
-      @shared_type
+    def access_type
+      @access_type
     end
 
-      # The method to set the value to shared_type
-      # @param shared_type [String] A String
+      # The method to set the value to access_type
+      # @param access_type [String] A String
 
-    def shared_type=(shared_type)
-      if shared_type!=nil and !shared_type.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_type EXPECTED TYPE: String', nil, nil)
+    def access_type=(access_type)
+      if access_type!=nil and !access_type.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: access_type EXPECTED TYPE: String', nil, nil)
       end
-      @shared_type = shared_type
-      @key_modified['shared_type'] = 1
+      @access_type = access_type
+      @key_modified['access_type'] = 1
     end
 
       # The method to get the category
@@ -186,24 +191,6 @@ module CustomViews
       @key_modified['favorite'] = 1
     end
 
-      # The method to get the offline
-      # @return A Boolean value
-
-    def offline
-      @offline
-    end
-
-      # The method to set the value to offline
-      # @param offline [Boolean] A Boolean
-
-    def offline=(offline)
-      if offline!=nil and ! [true, false].include?offline
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: offline EXPECTED TYPE: Boolean', nil, nil)
-      end
-      @offline = offline
-      @key_modified['offline'] = 1
-    end
-
       # The method to get the default
       # @return A Boolean value
 
@@ -258,22 +245,22 @@ module CustomViews
       @key_modified['criteria'] = 1
     end
 
-      # The method to get the shared_details
+      # The method to get the shared_to
       # @return An instance of Array
 
-    def shared_details
-      @shared_details
+    def shared_to
+      @shared_to
     end
 
-      # The method to set the value to shared_details
-      # @param shared_details [Array] An instance of Array
+      # The method to set the value to shared_to
+      # @param shared_to [Array] An instance of Array
 
-    def shared_details=(shared_details)
-      if shared_details!=nil and !shared_details.is_a? Array
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_details EXPECTED TYPE: Array', nil, nil)
+    def shared_to=(shared_to)
+      if shared_to!=nil and !shared_to.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_to EXPECTED TYPE: Array', nil, nil)
       end
-      @shared_details = shared_details
-      @key_modified['shared_details'] = 1
+      @shared_to = shared_to
+      @key_modified['shared_to'] = 1
     end
 
       # The method to get the fields
@@ -294,6 +281,78 @@ module CustomViews
       @key_modified['fields'] = 1
     end
 
+      # The method to get the modified_time
+      # @return An instance of DateTime
+
+    def modified_time
+      @modified_time
+    end
+
+      # The method to set the value to modified_time
+      # @param modified_time [DateTime] 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)
+      end
+      @modified_time = modified_time
+      @key_modified['modified_time'] = 1
+    end
+
+      # The method to get the modified_by
+      # @return An instance of Users::User
+
+    def modified_by
+      @modified_by
+    end
+
+      # The method to set the value to modified_by
+      # @param modified_by [Users::User] 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)
+      end
+      @modified_by = modified_by
+      @key_modified['modified_by'] = 1
+    end
+
+      # The method to get the last_accessed_time
+      # @return An instance of DateTime
+
+    def last_accessed_time
+      @last_accessed_time
+    end
+
+      # The method to set the value to last_accessed_time
+      # @param last_accessed_time [DateTime] An instance of DateTime
+
+    def last_accessed_time=(last_accessed_time)
+      if last_accessed_time!=nil and !last_accessed_time.is_a? DateTime
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: last_accessed_time EXPECTED TYPE: DateTime', nil, nil)
+      end
+      @last_accessed_time = last_accessed_time
+      @key_modified['last_accessed_time'] = 1
+    end
+
+      # The method to get the created_by
+      # @return An instance of Users::User
+
+    def created_by
+      @created_by
+    end
+
+      # The method to set the value to created_by
+      # @param created_by [Users::User] 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)
+      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

data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb

@@ -27,7 +27,7 @@ module CustomViews
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/settings/custom_views'
+      api_path = api_path + '/crm/v2.1/settings/custom_views'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET
       handler_instance.category_method = 'READ'
@@ -47,7 +47,7 @@ module CustomViews
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/settings/custom_views/'
+      api_path = api_path + '/crm/v2.1/settings/custom_views/'
       api_path = api_path + id.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET

data/src/com/zoho/crm/api/custom_views/{shared_details.rb → shared_to.rb}

@@ -1,10 +1,10 @@
 require_relative '../util/model'
 
 module CustomViews
-  class SharedDetails
+  class SharedTo
     include Util::Model
 
-    # Creates an instance of SharedDetails
+    # Creates an instance of SharedTo
     def initialize
       @id = nil
       @name = nil

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/email_templates/api_exception.rb

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module EmailTemplates
+  require_relative 'response_handler'
+  class APIException
+    include Util::Model
+    include ResponseHandler
+
+    # Creates an instance of APIException
+    def initialize
+      @code = nil
+      @status = nil
+      @message = nil
+      @details = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the code
+      # @return An instance of Util::Choice
+
+    def code
+      @code
+    end
+
+      # The method to set the value to code
+      # @param code [Util::Choice] An instance of Util::Choice
+
+    def code=(code)
+      if code!=nil and !code.is_a? Util::Choice
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Util::Choice', nil, nil)
+      end
+      @code = code
+      @key_modified['code'] = 1
+    end
+
+      # The method to get the status
+      # @return An instance of Util::Choice
+
+    def status
+      @status
+    end
+
+      # The method to set the value to status
+      # @param status [Util::Choice] An instance of Util::Choice
+
+    def status=(status)
+      if status!=nil and !status.is_a? Util::Choice
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Util::Choice', nil, nil)
+      end
+      @status = status
+      @key_modified['status'] = 1
+    end
+
+      # The method to get the message
+      # @return An instance of Util::Choice
+
+    def message
+      @message
+    end
+
+      # The method to set the value to message
+      # @param message [Util::Choice] An instance of Util::Choice
+
+    def message=(message)
+      if message!=nil and !message.is_a? Util::Choice
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Util::Choice', nil, nil)
+      end
+      @message = message
+      @key_modified['message'] = 1
+    end
+
+      # The method to get the details
+      # @return An instance of Hash
+
+    def details
+      @details
+    end
+
+      # The method to set the value to details
+      # @param details [Hash] An instance of Hash
+
+    def details=(details)
+      if details!=nil and !details.is_a? Hash
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Hash', nil, nil)
+      end
+      @details = details
+      @key_modified['details'] = 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