ZCRMSDK 2.0.0 → 3.0.0.beta

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

@@ -245,18 +245,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

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

@@ -0,0 +1,1107 @@
+require_relative '../custom_views/criteria'
+require_relative '../fields/association_details'
+require_relative '../fields/auto_number'
+require_relative '../fields/crypt'
+require_relative '../fields/currency'
+require_relative '../fields/external'
+require_relative '../fields/formula'
+require_relative '../fields/history_tracking'
+require_relative '../fields/module'
+require_relative '../fields/multi_select_lookup'
+require_relative '../fields/multi_user_lookup'
+require_relative '../fields/pick_list_value'
+require_relative '../fields/private'
+require_relative '../fields/related_details'
+require_relative '../fields/tool_tip'
+require_relative '../fields/unique'
+require_relative '../fields/view_type'
+require_relative '../layouts/layout'
+require_relative '../profiles/profile'
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module BluePrint
+  class Field
+    include Util::Model
+
+    # Creates an instance of Field
+    def initialize
+      @system_mandatory = nil
+      @webhook = nil
+      @private = nil
+      @layouts = nil
+      @profiles = nil
+      @sequence_number = nil
+      @content = nil
+      @column_name = nil
+      @type = nil
+      @transition_sequence = nil
+      @personality_name = nil
+      @message = nil
+      @mandatory = nil
+      @criteria = nil
+      @related_details = nil
+      @json_type = nil
+      @crypt = nil
+      @field_label = nil
+      @tooltip = nil
+      @created_source = nil
+      @field_read_only = nil
+      @display_label = nil
+      @ui_type = nil
+      @read_only = nil
+      @association_details = nil
+      @quick_sequence_number = nil
+      @businesscard_supported = nil
+      @multi_module_lookup = nil
+      @currency = nil
+      @id = nil
+      @custom_field = nil
+      @lookup = nil
+      @visible = nil
+      @pick_list_values_sorted_lexically = nil
+      @length = nil
+      @view_type = nil
+      @subform = nil
+      @api_name = nil
+      @sortable = nil
+      @unique = nil
+      @data_type = nil
+      @formula = nil
+      @decimal_place = nil
+      @mass_update = nil
+      @blueprint_supported = nil
+      @multiselectlookup = nil
+      @multiuserlookup = nil
+      @pick_list_values = nil
+      @auto_number = nil
+      @default_value = nil
+      @validation_rule = nil
+      @convert_mapping = nil
+      @external = nil
+      @history_tracking = nil
+      @display_type = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the system_mandatory
+      # @return A Boolean value
+
+    def system_mandatory
+      @system_mandatory
+    end
+
+      # The method to set the value to system_mandatory
+      # @param system_mandatory [Boolean] A Boolean
+
+    def system_mandatory=(system_mandatory)
+      if system_mandatory!=nil and ! [true, false].include?system_mandatory
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: system_mandatory EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @system_mandatory = system_mandatory
+      @key_modified['system_mandatory'] = 1
+    end
+
+      # The method to get the webhook
+      # @return A Boolean value
+
+    def webhook
+      @webhook
+    end
+
+      # The method to set the value to webhook
+      # @param webhook [Boolean] A Boolean
+
+    def webhook=(webhook)
+      if webhook!=nil and ! [true, false].include?webhook
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: webhook EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @webhook = webhook
+      @key_modified['webhook'] = 1
+    end
+
+      # The method to get the private
+      # @return An instance of Fields::Private
+
+    def private
+      @private
+    end
+
+      # The method to set the value to private
+      # @param private [Fields::Private] An instance of Fields::Private
+
+    def private=(private)
+      if private!=nil and !private.is_a? Fields::Private
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: private EXPECTED TYPE: Private', nil, nil)
+      end
+      @private = private
+      @key_modified['private'] = 1
+    end
+
+      # The method to get the layouts
+      # @return An instance of Layouts::Layout
+
+    def layouts
+      @layouts
+    end
+
+      # The method to set the value to layouts
+      # @param layouts [Layouts::Layout] An instance of Layouts::Layout
+
+    def layouts=(layouts)
+      if layouts!=nil and !layouts.is_a? Layouts::Layout
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: Layout', nil, nil)
+      end
+      @layouts = layouts
+      @key_modified['layouts'] = 1
+    end
+
+      # The method to get the profiles
+      # @return An instance of Array
+
+    def profiles
+      @profiles
+    end
+
+      # The method to set the value to profiles
+      # @param profiles [Array] An instance of Array
+
+    def profiles=(profiles)
+      if profiles!=nil and !profiles.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: Array', nil, nil)
+      end
+      @profiles = profiles
+      @key_modified['profiles'] = 1
+    end
+
+      # The method to get the sequence_number
+      # @return A Integer value
+
+    def sequence_number
+      @sequence_number
+    end
+
+      # The method to set the value to sequence_number
+      # @param sequence_number [Integer] A Integer
+
+    def sequence_number=(sequence_number)
+      if sequence_number!=nil and !sequence_number.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sequence_number EXPECTED TYPE: Integer', nil, nil)
+      end
+      @sequence_number = sequence_number
+      @key_modified['sequence_number'] = 1
+    end
+
+      # The method to get the content
+      # @return A String value
+
+    def content
+      @content
+    end
+
+      # The method to set the value to content
+      # @param content [String] A String
+
+    def content=(content)
+      if content!=nil and !content.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: String', nil, nil)
+      end
+      @content = content
+      @key_modified['content'] = 1
+    end
+
+      # The method to get the column_name
+      # @return A String value
+
+    def column_name
+      @column_name
+    end
+
+      # The method to set the value to column_name
+      # @param column_name [String] A String
+
+    def column_name=(column_name)
+      if column_name!=nil and !column_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: String', nil, nil)
+      end
+      @column_name = column_name
+      @key_modified['column_name'] = 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 transition_sequence
+      # @return A Integer value
+
+    def transition_sequence
+      @transition_sequence
+    end
+
+      # The method to set the value to transition_sequence
+      # @param transition_sequence [Integer] A Integer
+
+    def transition_sequence=(transition_sequence)
+      if transition_sequence!=nil and !transition_sequence.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: transition_sequence EXPECTED TYPE: Integer', nil, nil)
+      end
+      @transition_sequence = transition_sequence
+      @key_modified['transition_sequence'] = 1
+    end
+
+      # The method to get the personality_name
+      # @return A String value
+
+    def personality_name
+      @personality_name
+    end
+
+      # The method to set the value to personality_name
+      # @param personality_name [String] A String
+
+    def personality_name=(personality_name)
+      if personality_name!=nil and !personality_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: personality_name EXPECTED TYPE: String', nil, nil)
+      end
+      @personality_name = personality_name
+      @key_modified['personality_name'] = 1
+    end
+
+      # The method to get the message
+      # @return A String value
+
+    def message
+      @message
+    end
+
+      # The method to set the value to message
+      # @param message [String] A String
+
+    def message=(message)
+      if message!=nil and !message.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: String', nil, nil)
+      end
+      @message = message
+      @key_modified['message'] = 1
+    end
+
+      # The method to get the mandatory
+      # @return A Boolean value
+
+    def mandatory
+      @mandatory
+    end
+
+      # The method to set the value to mandatory
+      # @param mandatory [Boolean] A Boolean
+
+    def mandatory=(mandatory)
+      if mandatory!=nil and ! [true, false].include?mandatory
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: mandatory EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @mandatory = mandatory
+      @key_modified['mandatory'] = 1
+    end
+
+      # The method to get the criteria
+      # @return An instance of CustomViews::Criteria
+
+    def criteria
+      @criteria
+    end
+
+      # The method to set the value to criteria
+      # @param criteria [CustomViews::Criteria] An instance of CustomViews::Criteria
+
+    def criteria=(criteria)
+      if criteria!=nil and !criteria.is_a? CustomViews::Criteria
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', nil, nil)
+      end
+      @criteria = criteria
+      @key_modified['criteria'] = 1
+    end
+
+      # The method to get the related_details
+      # @return An instance of Fields::RelatedDetails
+
+    def related_details
+      @related_details
+    end
+
+      # The method to set the value to related_details
+      # @param related_details [Fields::RelatedDetails] An instance of Fields::RelatedDetails
+
+    def related_details=(related_details)
+      if related_details!=nil and !related_details.is_a? Fields::RelatedDetails
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_details EXPECTED TYPE: RelatedDetails', nil, nil)
+      end
+      @related_details = related_details
+      @key_modified['related_details'] = 1
+    end
+
+      # The method to get the json_type
+      # @return A String value
+
+    def json_type
+      @json_type
+    end
+
+      # The method to set the value to json_type
+      # @param json_type [String] A String
+
+    def json_type=(json_type)
+      if json_type!=nil and !json_type.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: json_type EXPECTED TYPE: String', nil, nil)
+      end
+      @json_type = json_type
+      @key_modified['json_type'] = 1
+    end
+
+      # The method to get the crypt
+      # @return An instance of Fields::Crypt
+
+    def crypt
+      @crypt
+    end
+
+      # The method to set the value to crypt
+      # @param crypt [Fields::Crypt] An instance of Fields::Crypt
+
+    def crypt=(crypt)
+      if crypt!=nil and !crypt.is_a? Fields::Crypt
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: crypt EXPECTED TYPE: Crypt', nil, nil)
+      end
+      @crypt = crypt
+      @key_modified['crypt'] = 1
+    end
+
+      # The method to get the field_label
+      # @return A String value
+
+    def field_label
+      @field_label
+    end
+
+      # The method to set the value to field_label
+      # @param field_label [String] A String
+
+    def field_label=(field_label)
+      if field_label!=nil and !field_label.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: String', nil, nil)
+      end
+      @field_label = field_label
+      @key_modified['field_label'] = 1
+    end
+
+      # The method to get the tooltip
+      # @return An instance of Fields::ToolTip
+
+    def tooltip
+      @tooltip
+    end
+
+      # The method to set the value to tooltip
+      # @param tooltip [Fields::ToolTip] An instance of Fields::ToolTip
+
+    def tooltip=(tooltip)
+      if tooltip!=nil and !tooltip.is_a? Fields::ToolTip
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: ToolTip', nil, nil)
+      end
+      @tooltip = tooltip
+      @key_modified['tooltip'] = 1
+    end
+
+      # The method to get the created_source
+      # @return A String value
+
+    def created_source
+      @created_source
+    end
+
+      # The method to set the value to created_source
+      # @param created_source [String] A String
+
+    def created_source=(created_source)
+      if created_source!=nil and !created_source.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_source EXPECTED TYPE: String', nil, nil)
+      end
+      @created_source = created_source
+      @key_modified['created_source'] = 1
+    end
+
+      # The method to get the field_read_only
+      # @return A Boolean value
+
+    def field_read_only
+      @field_read_only
+    end
+
+      # The method to set the value to field_read_only
+      # @param field_read_only [Boolean] A Boolean
+
+    def field_read_only=(field_read_only)
+      if field_read_only!=nil and ! [true, false].include?field_read_only
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field_read_only EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @field_read_only = field_read_only
+      @key_modified['field_read_only'] = 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 ui_type
+      # @return A Integer value
+
+    def ui_type
+      @ui_type
+    end
+
+      # The method to set the value to ui_type
+      # @param ui_type [Integer] A Integer
+
+    def ui_type=(ui_type)
+      if ui_type!=nil and !ui_type.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: Integer', nil, nil)
+      end
+      @ui_type = ui_type
+      @key_modified['ui_type'] = 1
+    end
+
+      # The method to get the read_only
+      # @return A Boolean value
+
+    def read_only
+      @read_only
+    end
+
+      # The method to set the value to read_only
+      # @param read_only [Boolean] A Boolean
+
+    def read_only=(read_only)
+      if read_only!=nil and ! [true, false].include?read_only
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @read_only = read_only
+      @key_modified['read_only'] = 1
+    end
+
+      # The method to get the association_details
+      # @return An instance of Fields::AssociationDetails
+
+    def association_details
+      @association_details
+    end
+
+      # The method to set the value to association_details
+      # @param association_details [Fields::AssociationDetails] An instance of Fields::AssociationDetails
+
+    def association_details=(association_details)
+      if association_details!=nil and !association_details.is_a? Fields::AssociationDetails
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: association_details EXPECTED TYPE: AssociationDetails', nil, nil)
+      end
+      @association_details = association_details
+      @key_modified['association_details'] = 1
+    end
+
+      # The method to get the quick_sequence_number
+      # @return A Integer value
+
+    def quick_sequence_number
+      @quick_sequence_number
+    end
+
+      # The method to set the value to quick_sequence_number
+      # @param quick_sequence_number [Integer] A Integer
+
+    def quick_sequence_number=(quick_sequence_number)
+      if quick_sequence_number!=nil and !quick_sequence_number.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: quick_sequence_number EXPECTED TYPE: Integer', nil, nil)
+      end
+      @quick_sequence_number = quick_sequence_number
+      @key_modified['quick_sequence_number'] = 1
+    end
+
+      # The method to get the businesscard_supported
+      # @return A Boolean value
+
+    def businesscard_supported
+      @businesscard_supported
+    end
+
+      # The method to set the value to businesscard_supported
+      # @param businesscard_supported [Boolean] A Boolean
+
+    def businesscard_supported=(businesscard_supported)
+      if businesscard_supported!=nil and ! [true, false].include?businesscard_supported
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: businesscard_supported EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @businesscard_supported = businesscard_supported
+      @key_modified['businesscard_supported'] = 1
+    end
+
+      # The method to get the multi_module_lookup
+      # @return An instance of Hash
+
+    def multi_module_lookup
+      @multi_module_lookup
+    end
+
+      # The method to set the value to multi_module_lookup
+      # @param multi_module_lookup [Hash] An instance of Hash
+
+    def multi_module_lookup=(multi_module_lookup)
+      if multi_module_lookup!=nil and !multi_module_lookup.is_a? Hash
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: multi_module_lookup EXPECTED TYPE: Hash', nil, nil)
+      end
+      @multi_module_lookup = multi_module_lookup
+      @key_modified['multi_module_lookup'] = 1
+    end
+
+      # The method to get the currency
+      # @return An instance of Fields::Currency
+
+    def currency
+      @currency
+    end
+
+      # The method to set the value to currency
+      # @param currency [Fields::Currency] An instance of Fields::Currency
+
+    def currency=(currency)
+      if currency!=nil and !currency.is_a? Fields::Currency
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: Currency', nil, nil)
+      end
+      @currency = currency
+      @key_modified['currency'] = 1
+    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 custom_field
+      # @return A Boolean value
+
+    def custom_field
+      @custom_field
+    end
+
+      # The method to set the value to custom_field
+      # @param custom_field [Boolean] A Boolean
+
+    def custom_field=(custom_field)
+      if custom_field!=nil and ! [true, false].include?custom_field
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: custom_field EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @custom_field = custom_field
+      @key_modified['custom_field'] = 1
+    end
+
+      # The method to get the lookup
+      # @return An instance of Fields::Module
+
+    def lookup
+      @lookup
+    end
+
+      # The method to set the value to lookup
+      # @param lookup [Fields::Module] An instance of Fields::Module
+
+    def lookup=(lookup)
+      if lookup!=nil and !lookup.is_a? Fields::Module
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: lookup EXPECTED TYPE: Module', nil, nil)
+      end
+      @lookup = lookup
+      @key_modified['lookup'] = 1
+    end
+
+      # The method to get the visible
+      # @return A Boolean value
+
+    def visible
+      @visible
+    end
+
+      # The method to set the value to visible
+      # @param visible [Boolean] A Boolean
+
+    def visible=(visible)
+      if visible!=nil and ! [true, false].include?visible
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @visible = visible
+      @key_modified['visible'] = 1
+    end
+
+      # The method to get the pick_list_values_sorted_lexically
+      # @return A Boolean value
+
+    def pick_list_values_sorted_lexically
+      @pick_list_values_sorted_lexically
+    end
+
+      # The method to set the value to pick_list_values_sorted_lexically
+      # @param pick_list_values_sorted_lexically [Boolean] A Boolean
+
+    def pick_list_values_sorted_lexically=(pick_list_values_sorted_lexically)
+      if pick_list_values_sorted_lexically!=nil and ! [true, false].include?pick_list_values_sorted_lexically
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @pick_list_values_sorted_lexically = pick_list_values_sorted_lexically
+      @key_modified['pick_list_values_sorted_lexically'] = 1
+    end
+
+      # The method to get the length
+      # @return A Integer value
+
+    def length
+      @length
+    end
+
+      # The method to set the value to length
+      # @param length [Integer] A Integer
+
+    def length=(length)
+      if length!=nil and !length.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: Integer', nil, nil)
+      end
+      @length = length
+      @key_modified['length'] = 1
+    end
+
+      # The method to get the view_type
+      # @return An instance of Fields::ViewType
+
+    def view_type
+      @view_type
+    end
+
+      # The method to set the value to view_type
+      # @param view_type [Fields::ViewType] An instance of Fields::ViewType
+
+    def view_type=(view_type)
+      if view_type!=nil and !view_type.is_a? Fields::ViewType
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: ViewType', nil, nil)
+      end
+      @view_type = view_type
+      @key_modified['view_type'] = 1
+    end
+
+      # The method to get the subform
+      # @return An instance of Fields::Module
+
+    def subform
+      @subform
+    end
+
+      # The method to set the value to subform
+      # @param subform [Fields::Module] An instance of Fields::Module
+
+    def subform=(subform)
+      if subform!=nil and !subform.is_a? Fields::Module
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: subform EXPECTED TYPE: Module', nil, nil)
+      end
+      @subform = subform
+      @key_modified['subform'] = 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 sortable
+      # @return A Boolean value
+
+    def sortable
+      @sortable
+    end
+
+      # The method to set the value to sortable
+      # @param sortable [Boolean] A Boolean
+
+    def sortable=(sortable)
+      if sortable!=nil and ! [true, false].include?sortable
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sortable EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @sortable = sortable
+      @key_modified['sortable'] = 1
+    end
+
+      # The method to get the unique
+      # @return An instance of Fields::Unique
+
+    def unique
+      @unique
+    end
+
+      # The method to set the value to unique
+      # @param unique [Fields::Unique] An instance of Fields::Unique
+
+    def unique=(unique)
+      if unique!=nil and !unique.is_a? Fields::Unique
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: unique EXPECTED TYPE: Unique', nil, nil)
+      end
+      @unique = unique
+      @key_modified['unique'] = 1
+    end
+
+      # The method to get the data_type
+      # @return A String value
+
+    def data_type
+      @data_type
+    end
+
+      # The method to set the value to data_type
+      # @param data_type [String] A String
+
+    def data_type=(data_type)
+      if data_type!=nil and !data_type.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: String', nil, nil)
+      end
+      @data_type = data_type
+      @key_modified['data_type'] = 1
+    end
+
+      # The method to get the formula
+      # @return An instance of Fields::Formula
+
+    def formula
+      @formula
+    end
+
+      # The method to set the value to formula
+      # @param formula [Fields::Formula] An instance of Fields::Formula
+
+    def formula=(formula)
+      if formula!=nil and !formula.is_a? Fields::Formula
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: formula EXPECTED TYPE: Formula', nil, nil)
+      end
+      @formula = formula
+      @key_modified['formula'] = 1
+    end
+
+      # The method to get the decimal_place
+      # @return A Integer value
+
+    def decimal_place
+      @decimal_place
+    end
+
+      # The method to set the value to decimal_place
+      # @param decimal_place [Integer] A Integer
+
+    def decimal_place=(decimal_place)
+      if decimal_place!=nil and !decimal_place.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: decimal_place EXPECTED TYPE: Integer', nil, nil)
+      end
+      @decimal_place = decimal_place
+      @key_modified['decimal_place'] = 1
+    end
+
+      # The method to get the mass_update
+      # @return A Boolean value
+
+    def mass_update
+      @mass_update
+    end
+
+      # The method to set the value to mass_update
+      # @param mass_update [Boolean] A Boolean
+
+    def mass_update=(mass_update)
+      if mass_update!=nil and ! [true, false].include?mass_update
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: mass_update EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @mass_update = mass_update
+      @key_modified['mass_update'] = 1
+    end
+
+      # The method to get the blueprint_supported
+      # @return A Boolean value
+
+    def blueprint_supported
+      @blueprint_supported
+    end
+
+      # The method to set the value to blueprint_supported
+      # @param blueprint_supported [Boolean] A Boolean
+
+    def blueprint_supported=(blueprint_supported)
+      if blueprint_supported!=nil and ! [true, false].include?blueprint_supported
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: blueprint_supported EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @blueprint_supported = blueprint_supported
+      @key_modified['blueprint_supported'] = 1
+    end
+
+      # The method to get the multiselectlookup
+      # @return An instance of Fields::MultiSelectLookup
+
+    def multiselectlookup
+      @multiselectlookup
+    end
+
+      # The method to set the value to multiselectlookup
+      # @param multiselectlookup [Fields::MultiSelectLookup] An instance of Fields::MultiSelectLookup
+
+    def multiselectlookup=(multiselectlookup)
+      if multiselectlookup!=nil and !multiselectlookup.is_a? Fields::MultiSelectLookup
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: multiselectlookup EXPECTED TYPE: MultiSelectLookup', nil, nil)
+      end
+      @multiselectlookup = multiselectlookup
+      @key_modified['multiselectlookup'] = 1
+    end
+
+      # The method to get the multiuserlookup
+      # @return An instance of Fields::MultiUserLookup
+
+    def multiuserlookup
+      @multiuserlookup
+    end
+
+      # The method to set the value to multiuserlookup
+      # @param multiuserlookup [Fields::MultiUserLookup] An instance of Fields::MultiUserLookup
+
+    def multiuserlookup=(multiuserlookup)
+      if multiuserlookup!=nil and !multiuserlookup.is_a? Fields::MultiUserLookup
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: multiuserlookup EXPECTED TYPE: MultiUserLookup', nil, nil)
+      end
+      @multiuserlookup = multiuserlookup
+      @key_modified['multiuserlookup'] = 1
+    end
+
+      # The method to get the pick_list_values
+      # @return An instance of Array
+
+    def pick_list_values
+      @pick_list_values
+    end
+
+      # The method to set the value to pick_list_values
+      # @param pick_list_values [Array] An instance of Array
+
+    def pick_list_values=(pick_list_values)
+      if pick_list_values!=nil and !pick_list_values.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: Array', nil, nil)
+      end
+      @pick_list_values = pick_list_values
+      @key_modified['pick_list_values'] = 1
+    end
+
+      # The method to get the auto_number
+      # @return An instance of Fields::AutoNumber
+
+    def auto_number
+      @auto_number
+    end
+
+      # The method to set the value to auto_number
+      # @param auto_number [Fields::AutoNumber] An instance of Fields::AutoNumber
+
+    def auto_number=(auto_number)
+      if auto_number!=nil and !auto_number.is_a? Fields::AutoNumber
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: auto_number EXPECTED TYPE: AutoNumber', nil, nil)
+      end
+      @auto_number = auto_number
+      @key_modified['auto_number'] = 1
+    end
+
+      # The method to get the default_value
+      # @return A String value
+
+    def default_value
+      @default_value
+    end
+
+      # The method to set the value to default_value
+      # @param default_value [String] A String
+
+    def default_value=(default_value)
+      if default_value!=nil and !default_value.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: String', nil, nil)
+      end
+      @default_value = default_value
+      @key_modified['default_value'] = 1
+    end
+
+      # The method to get the validation_rule
+      # @return An instance of Hash
+
+    def validation_rule
+      @validation_rule
+    end
+
+      # The method to set the value to validation_rule
+      # @param validation_rule [Hash] An instance of Hash
+
+    def validation_rule=(validation_rule)
+      if validation_rule!=nil and !validation_rule.is_a? Hash
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: validation_rule EXPECTED TYPE: Hash', nil, nil)
+      end
+      @validation_rule = validation_rule
+      @key_modified['validation_rule'] = 1
+    end
+
+      # The method to get the convert_mapping
+      # @return An instance of Hash
+
+    def convert_mapping
+      @convert_mapping
+    end
+
+      # The method to set the value to convert_mapping
+      # @param convert_mapping [Hash] An instance of Hash
+
+    def convert_mapping=(convert_mapping)
+      if convert_mapping!=nil and !convert_mapping.is_a? Hash
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: Hash', nil, nil)
+      end
+      @convert_mapping = convert_mapping
+      @key_modified['convert_mapping'] = 1
+    end
+
+      # The method to get the external
+      # @return An instance of Fields::External
+
+    def external
+      @external
+    end
+
+      # The method to set the value to external
+      # @param external [Fields::External] An instance of Fields::External
+
+    def external=(external)
+      if external!=nil and !external.is_a? Fields::External
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: external EXPECTED TYPE: External', nil, nil)
+      end
+      @external = external
+      @key_modified['external'] = 1
+    end
+
+      # The method to get the history_tracking
+      # @return An instance of Fields::HistoryTracking
+
+    def history_tracking
+      @history_tracking
+    end
+
+      # The method to set the value to history_tracking
+      # @param history_tracking [Fields::HistoryTracking] An instance of Fields::HistoryTracking
+
+    def history_tracking=(history_tracking)
+      if history_tracking!=nil and !history_tracking.is_a? Fields::HistoryTracking
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: history_tracking EXPECTED TYPE: HistoryTracking', nil, nil)
+      end
+      @history_tracking = history_tracking
+      @key_modified['history_tracking'] = 1
+    end
+
+      # The method to get the display_type
+      # @return An instance of Util::Choice
+
+    def display_type
+      @display_type
+    end
+
+      # The method to set the value to display_type
+      # @param display_type [Util::Choice] An instance of Util::Choice
+
+    def display_type=(display_type)
+      if display_type!=nil and !display_type.is_a? Util::Choice
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: Util::Choice', nil, nil)
+      end
+      @display_type = display_type
+      @key_modified['display_type'] = 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