ZCRMSDK 1.0.1 → 2.0.0

data/src/com/zoho/crm/api/record/successful_convert.rb

@@ -0,0 +1,101 @@
+require_relative '../util/model'
+
+module Record
+  require_relative 'convert_action_response'
+  class SuccessfulConvert
+    include Util::Model
+    include ConvertActionResponse
+
+    # Creates an instance of SuccessfulConvert
+    def initialize
+      @contacts = nil
+      @deals = nil
+      @accounts = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the contacts
+      # @return A String value
+
+    def contacts
+      @contacts
+    end
+
+      # The method to set the value to contacts
+      # @param contacts [String] A String
+
+    def contacts=(contacts)
+      if contacts!=nil and !contacts.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: String', nil, nil)
+      end
+      @contacts = contacts
+      @key_modified['Contacts'] = 1
+    end
+
+      # The method to get the deals
+      # @return A String value
+
+    def deals
+      @deals
+    end
+
+      # The method to set the value to deals
+      # @param deals [String] A String
+
+    def deals=(deals)
+      if deals!=nil and !deals.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: String', nil, nil)
+      end
+      @deals = deals
+      @key_modified['Deals'] = 1
+    end
+
+      # The method to get the accounts
+      # @return A String value
+
+    def accounts
+      @accounts
+    end
+
+      # The method to set the value to accounts
+      # @param accounts [String] A String
+
+    def accounts=(accounts)
+      if accounts!=nil and !accounts.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: String', nil, nil)
+      end
+      @accounts = accounts
+      @key_modified['Accounts'] = 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/record/territory.rb

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

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module RelatedLists
+  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/related_lists/related_list.rb

@@ -0,0 +1,251 @@
+require_relative '../util/model'
+
+module RelatedLists
+  class RelatedList
+    include Util::Model
+
+    # Creates an instance of RelatedList
+    def initialize
+      @id = nil
+      @sequence_number = nil
+      @display_label = nil
+      @api_name = nil
+      @module_1 = nil
+      @name = nil
+      @action = nil
+      @href = nil
+      @type = nil
+      @connectedmodule = nil
+      @linkingmodule = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the id
+      # @return A Integer value
+
+    def id
+      @id
+    end
+
+      # The method to set the value to id
+      # @param id [Integer] A Integer
+
+    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 get the sequence_number
+      # @return A String value
+
+    def sequence_number
+      @sequence_number
+    end
+
+      # The method to set the value to sequence_number
+      # @param sequence_number [String] A String
+
+    def sequence_number=(sequence_number)
+      if sequence_number!=nil and !sequence_number.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sequence_number EXPECTED TYPE: String', nil, nil)
+      end
+      @sequence_number = sequence_number
+      @key_modified['sequence_number'] = 1
+    end
+
+      # The method to get the display_label
+      # @return A String value
+
+    def display_label
+      @display_label
+    end
+
+      # The method to set the value to display_label
+      # @param display_label [String] A String
+
+    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 get the api_name
+      # @return A String value
+
+    def api_name
+      @api_name
+    end
+
+      # The method to set the value to api_name
+      # @param api_name [String] A String
+
+    def api_name=(api_name)
+      if api_name!=nil and !api_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: String', nil, nil)
+      end
+      @api_name = api_name
+      @key_modified['api_name'] = 1
+    end
+
+      # The method to get the module
+      # @return A String value
+
+    def module
+      @module_1
+    end
+
+      # The method to set the value to module
+      # @param module_1 [String] A String
+
+    def module=(module_1)
+      if module_1!=nil and !module_1.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
+      end
+      @module_1 = module_1
+      @key_modified['module'] = 1
+    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 action
+      # @return A String value
+
+    def action
+      @action
+    end
+
+      # The method to set the value to action
+      # @param action [String] A String
+
+    def action=(action)
+      if action!=nil and !action.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: String', nil, nil)
+      end
+      @action = action
+      @key_modified['action'] = 1
+    end
+
+      # The method to get the href
+      # @return A String value
+
+    def href
+      @href
+    end
+
+      # The method to set the value to href
+      # @param href [String] A String
+
+    def href=(href)
+      if href!=nil and !href.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: href EXPECTED TYPE: String', nil, nil)
+      end
+      @href = href
+      @key_modified['href'] = 1
+    end
+
+      # The method to get the type
+      # @return A String value
+
+    def type
+      @type
+    end
+
+      # The method to set the value to type
+      # @param type [String] A String
+
+    def type=(type)
+      if type!=nil and !type.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
+      end
+      @type = type
+      @key_modified['type'] = 1
+    end
+
+      # The method to get the connectedmodule
+      # @return A String value
+
+    def connectedmodule
+      @connectedmodule
+    end
+
+      # The method to set the value to connectedmodule
+      # @param connectedmodule [String] A String
+
+    def connectedmodule=(connectedmodule)
+      if connectedmodule!=nil and !connectedmodule.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: connectedmodule EXPECTED TYPE: String', nil, nil)
+      end
+      @connectedmodule = connectedmodule
+      @key_modified['connectedmodule'] = 1
+    end
+
+      # The method to get the linkingmodule
+      # @return A String value
+
+    def linkingmodule
+      @linkingmodule
+    end
+
+      # The method to set the value to linkingmodule
+      # @param linkingmodule [String] A String
+
+    def linkingmodule=(linkingmodule)
+      if linkingmodule!=nil and !linkingmodule.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: linkingmodule EXPECTED TYPE: String', nil, nil)
+      end
+      @linkingmodule = linkingmodule
+      @key_modified['linkingmodule'] = 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