ZCRMSDK 1.0.2 → 2.1.0

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

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

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

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

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

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

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Record
+  require_relative 'mass_update_action_response'
+  class MassUpdateSuccessResponse
+    include Util::Model
+    include MassUpdateActionResponse
+
+    # Creates an instance of MassUpdateSuccessResponse
+    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/record/options.rb

@@ -0,0 +1,10 @@
+module Record
+  class Options
+
+    # Creates an instance of Options
+    def initialize
+    end
+
+
+  end
+end

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

@@ -0,0 +1,116 @@
+require_relative '../record/record'
+require_relative '../util/model'
+
+module Record
+  class Participants < Record
+    include Util::Model
+
+    # Creates an instance of Participants
+    def initialize
+      super
+    end
+
+      # The method to get the name
+      # @return A String value
+
+    def name
+      get_key_value('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
+      add_key_value('name', name)
+    end
+
+      # The method to get the email
+      # @return A String value
+
+    def email
+      get_key_value('Email')
+    end
+
+      # The method to set the value to email
+      # @param email [String] A String
+
+    def email=(email)
+      if email!=nil and !email.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: String', nil, nil)
+      end
+      add_key_value('Email', email)
+    end
+
+      # The method to get the invited
+      # @return A Boolean value
+
+    def invited
+      get_key_value('invited')
+    end
+
+      # The method to set the value to invited
+      # @param invited [Boolean] A Boolean
+
+    def invited=(invited)
+      if invited!=nil and ! [true, false].include?invited
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: invited EXPECTED TYPE: Boolean', nil, nil)
+      end
+      add_key_value('invited', invited)
+    end
+
+      # The method to get the type
+      # @return A String value
+
+    def type
+      get_key_value('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
+      add_key_value('type', type)
+    end
+
+      # The method to get the participant
+      # @return A String value
+
+    def participant
+      get_key_value('participant')
+    end
+
+      # The method to set the value to participant
+      # @param participant [String] A String
+
+    def participant=(participant)
+      if participant!=nil and !participant.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: participant EXPECTED TYPE: String', nil, nil)
+      end
+      add_key_value('participant', participant)
+    end
+
+      # The method to get the status
+      # @return A String value
+
+    def status
+      get_key_value('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
+      add_key_value('status', status)
+    end
+
+  end
+end

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

@@ -0,0 +1,65 @@
+require_relative '../record/record'
+require_relative '../util/model'
+
+module Record
+  class PricingDetails < Record
+    include Util::Model
+
+    # Creates an instance of PricingDetails
+    def initialize
+      super
+    end
+
+      # The method to get the to_range
+      # @return An instance of Float
+
+    def to_range
+      get_key_value('to_range')
+    end
+
+      # The method to set the value to to_range
+      # @param to_range [Float] An instance of Float
+
+    def to_range=(to_range)
+      if to_range!=nil and !to_range.is_a? Float
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: to_range EXPECTED TYPE: Float', nil, nil)
+      end
+      add_key_value('to_range', to_range)
+    end
+
+      # The method to get the discount
+      # @return An instance of Float
+
+    def discount
+      get_key_value('discount')
+    end
+
+      # The method to set the value to discount
+      # @param discount [Float] An instance of Float
+
+    def discount=(discount)
+      if discount!=nil and !discount.is_a? Float
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: discount EXPECTED TYPE: Float', nil, nil)
+      end
+      add_key_value('discount', discount)
+    end
+
+      # The method to get the from_range
+      # @return An instance of Float
+
+    def from_range
+      get_key_value('from_range')
+    end
+
+      # The method to set the value to from_range
+      # @param from_range [Float] An instance of Float
+
+    def from_range=(from_range)
+      if from_range!=nil and !from_range.is_a? Float
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: from_range EXPECTED TYPE: Float', nil, nil)
+      end
+      add_key_value('from_range', from_range)
+    end
+
+  end
+end

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

@@ -0,0 +1,192 @@
+require_relative '../tags/tag'
+require_relative '../users/user'
+require_relative '../util/model'
+
+module Record
+  class Record
+    include Util::Model
+
+    # Creates an instance of Record
+    def initialize
+      @key_values = Hash.new
+      @key_modified = Hash.new
+    end
+
+      # The method to get the id
+      # @return A Integer value
+
+    def id
+      get_key_value('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
+      add_key_value('id', id)
+    end
+
+      # The method to get the created_by
+      # @return An instance of Users::User
+
+    def created_by
+      get_key_value('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
+      add_key_value('Created_By', created_by)
+    end
+
+      # The method to get the created_time
+      # @return An instance of DateTime
+
+    def created_time
+      get_key_value('Created_Time')
+    end
+
+      # The method to set the value to created_time
+      # @param created_time [DateTime] An instance of DateTime
+
+    def created_time=(created_time)
+      if created_time!=nil and !created_time.is_a? DateTime
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: DateTime', nil, nil)
+      end
+      add_key_value('Created_Time', created_time)
+    end
+
+      # The method to get the modified_by
+      # @return An instance of Users::User
+
+    def modified_by
+      get_key_value('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
+      add_key_value('Modified_By', modified_by)
+    end
+
+      # The method to get the modified_time
+      # @return An instance of DateTime
+
+    def modified_time
+      get_key_value('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
+      add_key_value('Modified_Time', modified_time)
+    end
+
+      # The method to get the tag
+      # @return An instance of Array
+
+    def tag
+      get_key_value('Tag')
+    end
+
+      # The method to set the value to tag
+      # @param tag [Array] An instance of Array
+
+    def tag=(tag)
+      if tag!=nil and !tag.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: Array', nil, nil)
+      end
+      add_key_value('Tag', tag)
+    end
+
+      # The method to add field value
+      # @param field [Field] An instance of Field
+      # @param value [object] A Object
+
+    def add_field_value(field, value)
+      if field!=nil and !field.is_a? Field
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', nil, nil)
+      end
+      add_key_value(field.api_name, value)
+    end
+
+      # The method to add key value
+      # @param api_name [String] A String
+      # @param value [lang::Object] A lang::Object
+
+    def add_key_value(api_name, value)
+      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
+      @key_values[api_name] = value
+      @key_modified[api_name] = 1
+    end
+
+      # The method to get key value
+      # @param api_name [String] A String
+      # @return A lang::Object value
+
+    def get_key_value(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
+      if @key_values.key?(api_name)
+        return @key_values[api_name]
+      end
+
+      nil
+    end
+
+      # The method to get key values
+      # @return An instance of Hash
+
+    def get_key_values
+      @key_values
+    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