ZCRMSDK 1.0.4 → 3.0.0

data/src/com/zoho/crm/api/notes/action_handler.rb

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

data/src/com/zoho/crm/api/notes/action_response.rb

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

data/src/com/zoho/crm/api/notes/action_wrapper.rb

@@ -0,0 +1,63 @@
+require_relative '../util/model'
+
+module Notes
+  require_relative 'action_handler'
+  class ActionWrapper
+    include Util::Model
+    include ActionHandler
+
+    # Creates an instance of ActionWrapper
+    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/notes/api_exception.rb

@@ -0,0 +1,125 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Notes
+  require_relative 'response_handler'
+  require_relative 'action_response'
+  require_relative 'action_handler'
+  class APIException
+    include Util::Model
+    include ResponseHandler
+    include ActionResponse
+    include ActionHandler
+
+    # 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/notes/body_wrapper.rb

@@ -0,0 +1,61 @@
+require_relative '../util/model'
+
+module Notes
+  class BodyWrapper
+    include Util::Model
+
+    # Creates an instance of BodyWrapper
+    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/notes/info.rb

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

@@ -0,0 +1,368 @@
+require_relative '../attachments/attachment'
+require_relative '../record/record'
+require_relative '../users/user'
+require_relative '../util/model'
+
+module Notes
+  class Note
+    include Util::Model
+
+    # Creates an instance of Note
+    def initialize
+      @owner = nil
+      @modified_time = nil
+      @attachments = nil
+      @created_time = nil
+      @parent_id = nil
+      @editable = nil
+      @sharing_permission = nil
+      @se_module = nil
+      @is_shared_to_client = nil
+      @modified_by = nil
+      @size = nil
+      @state = nil
+      @voice_note = nil
+      @id = nil
+      @created_by = nil
+      @note_title = nil
+      @note_content = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the owner
+      # @return An instance of Users::User
+
+    def owner
+      @owner
+    end
+
+      # The method to set the value to owner
+      # @param owner [Users::User] An instance of Users::User
+
+    def owner=(owner)
+      if owner!=nil and !owner.is_a? Users::User
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: User', nil, nil)
+      end
+      @owner = owner
+      @key_modified['Owner'] = 1
+    end
+
+      # The method to get the modified_time
+      # @return An instance of DateTime
+
+    def modified_time
+      @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
+      @modified_time = modified_time
+      @key_modified['Modified_Time'] = 1
+    end
+
+      # The method to get the attachments
+      # @return An instance of Array
+
+    def attachments
+      @attachments
+    end
+
+      # The method to set the value to attachments
+      # @param attachments [Array] An instance of Array
+
+    def attachments=(attachments)
+      if attachments!=nil and !attachments.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: Array', nil, nil)
+      end
+      @attachments = attachments
+      @key_modified['$attachments'] = 1
+    end
+
+      # The method to get the created_time
+      # @return An instance of DateTime
+
+    def created_time
+      @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
+      @created_time = created_time
+      @key_modified['Created_Time'] = 1
+    end
+
+      # The method to get the parent_id
+      # @return An instance of Record::Record
+
+    def parent_id
+      @parent_id
+    end
+
+      # The method to set the value to parent_id
+      # @param parent_id [Record::Record] An instance of Record::Record
+
+    def parent_id=(parent_id)
+      if parent_id!=nil and !parent_id.is_a? Record::Record
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: parent_id EXPECTED TYPE: Record', nil, nil)
+      end
+      @parent_id = parent_id
+      @key_modified['Parent_Id'] = 1
+    end
+
+      # The method to get the editable
+      # @return A Boolean value
+
+    def editable
+      @editable
+    end
+
+      # The method to set the value to editable
+      # @param editable [Boolean] A Boolean
+
+    def editable=(editable)
+      if editable!=nil and ! [true, false].include?editable
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: editable EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @editable = editable
+      @key_modified['$editable'] = 1
+    end
+
+      # The method to get the sharing_permission
+      # @return A String value
+
+    def sharing_permission
+      @sharing_permission
+    end
+
+      # The method to set the value to sharing_permission
+      # @param sharing_permission [String] A String
+
+    def sharing_permission=(sharing_permission)
+      if sharing_permission!=nil and !sharing_permission.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sharing_permission EXPECTED TYPE: String', nil, nil)
+      end
+      @sharing_permission = sharing_permission
+      @key_modified['$sharing_permission'] = 1
+    end
+
+      # The method to get the se_module
+      # @return A String value
+
+    def se_module
+      @se_module
+    end
+
+      # The method to set the value to se_module
+      # @param se_module [String] A String
+
+    def se_module=(se_module)
+      if se_module!=nil and !se_module.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: se_module EXPECTED TYPE: String', nil, nil)
+      end
+      @se_module = se_module
+      @key_modified['$se_module'] = 1
+    end
+
+      # The method to get the is_shared_to_client
+      # @return A Boolean value
+
+    def is_shared_to_client
+      @is_shared_to_client
+    end
+
+      # The method to set the value to is_shared_to_client
+      # @param is_shared_to_client [Boolean] A Boolean
+
+    def is_shared_to_client=(is_shared_to_client)
+      if is_shared_to_client!=nil and ! [true, false].include?is_shared_to_client
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: is_shared_to_client EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @is_shared_to_client = is_shared_to_client
+      @key_modified['$is_shared_to_client'] = 1
+    end
+
+      # The method to get the modified_by
+      # @return An instance of Users::User
+
+    def modified_by
+      @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
+      @modified_by = modified_by
+      @key_modified['Modified_By'] = 1
+    end
+
+      # The method to get the size
+      # @return A String value
+
+    def size
+      @size
+    end
+
+      # The method to set the value to size
+      # @param size [String] A String
+
+    def size=(size)
+      if size!=nil and !size.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: size EXPECTED TYPE: String', nil, nil)
+      end
+      @size = size
+      @key_modified['$size'] = 1
+    end
+
+      # The method to get the state
+      # @return A String value
+
+    def state
+      @state
+    end
+
+      # The method to set the value to state
+      # @param state [String] A String
+
+    def state=(state)
+      if state!=nil and !state.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: String', nil, nil)
+      end
+      @state = state
+      @key_modified['$state'] = 1
+    end
+
+      # The method to get the voice_note
+      # @return A Boolean value
+
+    def voice_note
+      @voice_note
+    end
+
+      # The method to set the value to voice_note
+      # @param voice_note [Boolean] A Boolean
+
+    def voice_note=(voice_note)
+      if voice_note!=nil and ! [true, false].include?voice_note
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: voice_note EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @voice_note = voice_note
+      @key_modified['$voice_note'] = 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 created_by
+      # @return An instance of Users::User
+
+    def created_by
+      @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
+      @created_by = created_by
+      @key_modified['Created_By'] = 1
+    end
+
+      # The method to get the note_title
+      # @return A String value
+
+    def note_title
+      @note_title
+    end
+
+      # The method to set the value to note_title
+      # @param note_title [String] A String
+
+    def note_title=(note_title)
+      if note_title!=nil and !note_title.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: note_title EXPECTED TYPE: String', nil, nil)
+      end
+      @note_title = note_title
+      @key_modified['Note_Title'] = 1
+    end
+
+      # The method to get the note_content
+      # @return A String value
+
+    def note_content
+      @note_content
+    end
+
+      # The method to set the value to note_content
+      # @param note_content [String] A String
+
+    def note_content=(note_content)
+      if note_content!=nil and !note_content.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: note_content EXPECTED TYPE: String', nil, nil)
+      end
+      @note_content = note_content
+      @key_modified['Note_Content'] = 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