ZCRMSDK 1.0.1 → 2.0.0

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

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

@@ -0,0 +1,18 @@
+require_relative 'datacenter'
+module DC
+  class AUDataCenter < DataCenter
+    def initialize; end
+
+    def get_iam_url
+      'https://accounts.zoho.com.au/oauth/v2/token'
+    end
+
+    def get_file_upload_url
+      '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)
+  end
+end

data/src/com/zoho/crm/api/dc/cn_datacenter.rb

@@ -0,0 +1,18 @@
+require_relative 'datacenter'
+module DC
+  class CNDataCenter < DataCenter
+    def initialize; end
+
+    def get_iam_url
+      'https://accounts.zoho.com.cn/oauth/v2/token'
+    end
+
+    def get_file_upload_url
+      '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)
+  end
+end

data/src/com/zoho/crm/api/dc/datacenter.rb

@@ -0,0 +1,20 @@
+module DC
+  class DataCenter
+    def get_iam_url
+      nil
+    end
+
+    def get_file_upload_url
+      nil
+    end
+
+    class Environment
+      attr_reader :accounts_url, :url, :file_upload_url
+      def initialize(url, accounts_url, file_upload_url)
+        @url = url
+        @accounts_url = accounts_url
+        @file_upload_url = file_upload_url
+      end
+    end
+  end
+end

data/src/com/zoho/crm/api/dc/eu_datacenter.rb

@@ -0,0 +1,18 @@
+require_relative 'datacenter'
+module DC
+  class EUDataCenter < DataCenter
+    def initialize; end
+
+    def get_iam_url
+      'https://accounts.zoho.eu/oauth/v2/token'
+    end
+
+    def get_file_upload_url
+      '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)
+  end
+end

data/src/com/zoho/crm/api/dc/in_datacenter.rb

@@ -0,0 +1,18 @@
+require_relative 'datacenter'
+module DC
+  class INDataCenter < DataCenter
+    def initialize; end
+
+    def get_iam_url
+      'https://accounts.zoho.in/oauth/v2/token'
+    end
+
+    def get_file_upload_url
+      '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)
+  end
+end

data/src/com/zoho/crm/api/dc/us_datacenter.rb

@@ -0,0 +1,18 @@
+require_relative 'datacenter'
+module DC
+  class USDataCenter < DataCenter
+    def initialize; end
+
+    def get_iam_url
+      'https://accounts.zoho.com/oauth/v2/token'
+    end
+
+    def get_file_upload_url
+      '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)
+  end
+end

data/src/com/zoho/crm/api/exception/sdk_exception.rb

@@ -0,0 +1,47 @@
+# This class is the common SDKException object.
+class SDKException < StandardError
+  attr_reader :code, :message, :cause, :details, :back_trace
+
+  # Creates an SDKException class instance with the specified parameters.
+  # @param code A String containing the Exception error code.
+  # @param message A String containing the Exception error message.
+  # @param details A hash containing the error response.
+  # @param cause An Exception class instance.
+  def initialize(code, message, details = nil, cause = nil)
+    @code = code
+    @message = message
+    @cause = cause
+    @details = details
+
+    return if cause.nil?
+
+    set_backtrace(cause.backtrace)
+    @message = '' if @message.nil?
+    if cause.is_a? SDKException
+      @message += cause.to_s
+    else
+      cause_message = if cause.message.nil?
+                        cause.class.name
+                      else
+                        cause.class.name + ' : ' + cause.message
+                      end
+
+      @message = @message.nil? ? cause_message : @message + cause_message
+    end
+  end
+
+  def to_s
+    return_msg = ''
+
+    unless @details.nil?
+      @message = @message.nil? ? @details.to_s : (@message + @details.to_s)
+    end
+
+    return_msg += if @code.nil?
+                    @message
+                  else
+                    @code + '_' + @message
+                  end
+    return_msg
+  end
+end

data/src/com/zoho/crm/api/fields/api_exception.rb

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Fields
+  require_relative 'response_handler'
+  class APIException
+    include Util::Model
+    include ResponseHandler
+
+    # Creates an instance of APIException
+    def initialize
+      @status = nil
+      @code = nil
+      @message = nil
+      @details = nil
+      @key_modified = Hash.new
+    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 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 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

data/src/com/zoho/crm/api/fields/association_details.rb

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