ZOHOCRMSDK5_0 1.0.0

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

@@ -0,0 +1,158 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Record
+    class BodyWrapper
+      include Util::Model
+
+      # Creates an instance of BodyWrapper
+      def initialize
+        @data = nil
+        @trigger = nil
+        @process = nil
+        @duplicate_check_fields = nil
+        @wf_trigger = nil
+        @lar_id = 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 get the trigger
+        # @return An instance of Array
+
+      def trigger
+        @trigger
+      end
+
+        # The method to set the value to trigger
+        # @param trigger [Array] An instance of Array
+
+      def trigger=(trigger)
+        if trigger!=nil and !trigger.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: trigger EXPECTED TYPE: Array', nil, nil)
+        end
+        @trigger = trigger
+        @key_modified['trigger'] = 1
+      end
+
+        # The method to get the process
+        # @return An instance of Array
+
+      def process
+        @process
+      end
+
+        # The method to set the value to process
+        # @param process [Array] An instance of Array
+
+      def process=(process)
+        if process!=nil and !process.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: process EXPECTED TYPE: Array', nil, nil)
+        end
+        @process = process
+        @key_modified['process'] = 1
+      end
+
+        # The method to get the duplicate_check_fields
+        # @return An instance of Array
+
+      def duplicate_check_fields
+        @duplicate_check_fields
+      end
+
+        # The method to set the value to duplicate_check_fields
+        # @param duplicate_check_fields [Array] An instance of Array
+
+      def duplicate_check_fields=(duplicate_check_fields)
+        if duplicate_check_fields!=nil and !duplicate_check_fields.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: duplicate_check_fields EXPECTED TYPE: Array', nil, nil)
+        end
+        @duplicate_check_fields = duplicate_check_fields
+        @key_modified['duplicate_check_fields'] = 1
+      end
+
+        # The method to get the wf_trigger
+        # @return A String value
+
+      def wf_trigger
+        @wf_trigger
+      end
+
+        # The method to set the value to wf_trigger
+        # @param wf_trigger [String] A String
+
+      def wf_trigger=(wf_trigger)
+        if wf_trigger!=nil and !wf_trigger.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: wf_trigger EXPECTED TYPE: String', nil, nil)
+        end
+        @wf_trigger = wf_trigger
+        @key_modified['wf_trigger'] = 1
+      end
+
+        # The method to get the lar_id
+        # @return A String value
+
+      def lar_id
+        @lar_id
+      end
+
+        # The method to set the value to lar_id
+        # @param lar_id [String] A String
+
+      def lar_id=(lar_id)
+        if lar_id!=nil and !lar_id.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: lar_id EXPECTED TYPE: String', nil, nil)
+        end
+        @lar_id = lar_id
+        @key_modified['lar_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
+end

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

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

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

@@ -0,0 +1,120 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Record
+    class Comment
+      include Util::Model
+
+      # Creates an instance of Comment
+      def initialize
+        @commented_by = nil
+        @commented_time = nil
+        @comment_content = nil
+        @id = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the commented_by
+        # @return A String value
+
+      def commented_by
+        @commented_by
+      end
+
+        # The method to set the value to commented_by
+        # @param commented_by [String] A String
+
+      def commented_by=(commented_by)
+        if commented_by!=nil and !commented_by.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: commented_by EXPECTED TYPE: String', nil, nil)
+        end
+        @commented_by = commented_by
+        @key_modified['commented_by'] = 1
+      end
+
+        # The method to get the commented_time
+        # @return An instance of DateTime
+
+      def commented_time
+        @commented_time
+      end
+
+        # The method to set the value to commented_time
+        # @param commented_time [DateTime] An instance of DateTime
+
+      def commented_time=(commented_time)
+        if commented_time!=nil and !commented_time.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: commented_time EXPECTED TYPE: DateTime', nil, nil)
+        end
+        @commented_time = commented_time
+        @key_modified['commented_time'] = 1
+      end
+
+        # The method to get the comment_content
+        # @return A String value
+
+      def comment_content
+        @comment_content
+      end
+
+        # The method to set the value to comment_content
+        # @param comment_content [String] A String
+
+      def comment_content=(comment_content)
+        if comment_content!=nil and !comment_content.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: comment_content EXPECTED TYPE: String', nil, nil)
+        end
+        @comment_content = comment_content
+        @key_modified['comment_content'] = 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 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
+end

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

@@ -0,0 +1,307 @@
+require_relative '../tags/tag'
+require_relative '../users/minified_user'
+require_relative '../record/record'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Record
+    class Consent < Record
+      include Util::Model
+
+      # Creates an instance of Consent
+      def initialize
+        super
+      end
+
+        # The method to get the owner
+        # @return An instance of Users::MinifiedUser
+
+      def owner
+        get_key_value('Owner')
+      end
+
+        # The method to set the value to owner
+        # @param owner [Users::MinifiedUser] An instance of Users::MinifiedUser
+
+      def owner=(owner)
+        if owner!=nil and !owner.is_a? Users::MinifiedUser
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: MinifiedUser', nil, nil)
+        end
+        add_key_value('Owner', owner)
+      end
+
+        # The method to get the contact_through_email
+        # @return A Boolean value
+
+      def contact_through_email
+        get_key_value('Contact_Through_Email')
+      end
+
+        # The method to set the value to contact_through_email
+        # @param contact_through_email [Boolean] A Boolean
+
+      def contact_through_email=(contact_through_email)
+        if contact_through_email!=nil and ! [true, false].include?contact_through_email
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: contact_through_email EXPECTED TYPE: Boolean', nil, nil)
+        end
+        add_key_value('Contact_Through_Email', contact_through_email)
+      end
+
+        # The method to get the contact_through_social
+        # @return A Boolean value
+
+      def contact_through_social
+        get_key_value('Contact_Through_Social')
+      end
+
+        # The method to set the value to contact_through_social
+        # @param contact_through_social [Boolean] A Boolean
+
+      def contact_through_social=(contact_through_social)
+        if contact_through_social!=nil and ! [true, false].include?contact_through_social
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: contact_through_social EXPECTED TYPE: Boolean', nil, nil)
+        end
+        add_key_value('Contact_Through_Social', contact_through_social)
+      end
+
+        # The method to get the contact_through_survey
+        # @return A Boolean value
+
+      def contact_through_survey
+        get_key_value('Contact_Through_Survey')
+      end
+
+        # The method to set the value to contact_through_survey
+        # @param contact_through_survey [Boolean] A Boolean
+
+      def contact_through_survey=(contact_through_survey)
+        if contact_through_survey!=nil and ! [true, false].include?contact_through_survey
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: contact_through_survey EXPECTED TYPE: Boolean', nil, nil)
+        end
+        add_key_value('Contact_Through_Survey', contact_through_survey)
+      end
+
+        # The method to get the contact_through_phone
+        # @return A Boolean value
+
+      def contact_through_phone
+        get_key_value('Contact_Through_Phone')
+      end
+
+        # The method to set the value to contact_through_phone
+        # @param contact_through_phone [Boolean] A Boolean
+
+      def contact_through_phone=(contact_through_phone)
+        if contact_through_phone!=nil and ! [true, false].include?contact_through_phone
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: contact_through_phone EXPECTED TYPE: Boolean', nil, nil)
+        end
+        add_key_value('Contact_Through_Phone', contact_through_phone)
+      end
+
+        # The method to get the mail_sent_time
+        # @return An instance of DateTime
+
+      def mail_sent_time
+        get_key_value('Mail_Sent_Time')
+      end
+
+        # The method to set the value to mail_sent_time
+        # @param mail_sent_time [DateTime] An instance of DateTime
+
+      def mail_sent_time=(mail_sent_time)
+        if mail_sent_time!=nil and !mail_sent_time.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: mail_sent_time EXPECTED TYPE: DateTime', nil, nil)
+        end
+        add_key_value('Mail_Sent_Time', mail_sent_time)
+      end
+
+        # The method to get the consent_date
+        # @return An instance of Date
+
+      def consent_date
+        get_key_value('Consent_Date')
+      end
+
+        # The method to set the value to consent_date
+        # @param consent_date [Date] An instance of Date
+
+      def consent_date=(consent_date)
+        if consent_date!=nil and !consent_date.is_a? Date
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: consent_date EXPECTED TYPE: Date', nil, nil)
+        end
+        add_key_value('Consent_Date', consent_date)
+      end
+
+        # The method to get the consent_remarks
+        # @return A String value
+
+      def consent_remarks
+        get_key_value('Consent_Remarks')
+      end
+
+        # The method to set the value to consent_remarks
+        # @param consent_remarks [String] A String
+
+      def consent_remarks=(consent_remarks)
+        if consent_remarks!=nil and !consent_remarks.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: consent_remarks EXPECTED TYPE: String', nil, nil)
+        end
+        add_key_value('Consent_Remarks', consent_remarks)
+      end
+
+        # The method to get the consent_through
+        # @return A String value
+
+      def consent_through
+        get_key_value('Consent_Through')
+      end
+
+        # The method to set the value to consent_through
+        # @param consent_through [String] A String
+
+      def consent_through=(consent_through)
+        if consent_through!=nil and !consent_through.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: consent_through EXPECTED TYPE: String', nil, nil)
+        end
+        add_key_value('Consent_Through', consent_through)
+      end
+
+        # The method to get the data_processing_basis
+        # @return A String value
+
+      def data_processing_basis
+        get_key_value('Data_Processing_Basis')
+      end
+
+        # The method to set the value to data_processing_basis
+        # @param data_processing_basis [String] A String
+
+      def data_processing_basis=(data_processing_basis)
+        if data_processing_basis!=nil and !data_processing_basis.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data_processing_basis EXPECTED TYPE: String', nil, nil)
+        end
+        add_key_value('Data_Processing_Basis', data_processing_basis)
+      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::MinifiedUser
+
+      def created_by
+        get_key_value('Created_By')
+      end
+
+        # The method to set the value to created_by
+        # @param created_by [Users::MinifiedUser] An instance of Users::MinifiedUser
+
+      def created_by=(created_by)
+        if created_by!=nil and !created_by.is_a? Users::MinifiedUser
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', 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::MinifiedUser
+
+      def modified_by
+        get_key_value('Modified_By')
+      end
+
+        # The method to set the value to modified_by
+        # @param modified_by [Users::MinifiedUser] An instance of Users::MinifiedUser
+
+      def modified_by=(modified_by)
+        if modified_by!=nil and !modified_by.is_a? Users::MinifiedUser
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', 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 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
+
+    end
+  end
+end