ZCRMSDK 1.0.5 → 2.0.0

data/src/com/zoho/crm/api/users/api_exception.rb

@@ -0,0 +1,125 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Users
+  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/users/body_wrapper.rb

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

@@ -0,0 +1,156 @@
+require_relative '../util/model'
+
+module Users
+  class CustomizeInfo
+    include Util::Model
+
+    # Creates an instance of CustomizeInfo
+    def initialize
+      @notes_desc = nil
+      @show_right_panel = nil
+      @bc_view = nil
+      @show_home = nil
+      @show_detail_view = nil
+      @unpin_recent_item = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the notes_desc
+      # @return A Boolean value
+
+    def notes_desc
+      @notes_desc
+    end
+
+      # The method to set the value to notes_desc
+      # @param notes_desc [Boolean] A Boolean
+
+    def notes_desc=(notes_desc)
+      if notes_desc!=nil and ! [true, false].include?notes_desc
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: notes_desc EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @notes_desc = notes_desc
+      @key_modified['notes_desc'] = 1
+    end
+
+      # The method to get the show_right_panel
+      # @return A String value
+
+    def show_right_panel
+      @show_right_panel
+    end
+
+      # The method to set the value to show_right_panel
+      # @param show_right_panel [String] A String
+
+    def show_right_panel=(show_right_panel)
+      if show_right_panel!=nil and !show_right_panel.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: show_right_panel EXPECTED TYPE: String', nil, nil)
+      end
+      @show_right_panel = show_right_panel
+      @key_modified['show_right_panel'] = 1
+    end
+
+      # The method to get the bc_view
+      # @return A String value
+
+    def bc_view
+      @bc_view
+    end
+
+      # The method to set the value to bc_view
+      # @param bc_view [String] A String
+
+    def bc_view=(bc_view)
+      if bc_view!=nil and !bc_view.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: bc_view EXPECTED TYPE: String', nil, nil)
+      end
+      @bc_view = bc_view
+      @key_modified['bc_view'] = 1
+    end
+
+      # The method to get the show_home
+      # @return A Boolean value
+
+    def show_home
+      @show_home
+    end
+
+      # The method to set the value to show_home
+      # @param show_home [Boolean] A Boolean
+
+    def show_home=(show_home)
+      if show_home!=nil and ! [true, false].include?show_home
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: show_home EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @show_home = show_home
+      @key_modified['show_home'] = 1
+    end
+
+      # The method to get the show_detail_view
+      # @return A Boolean value
+
+    def show_detail_view
+      @show_detail_view
+    end
+
+      # The method to set the value to show_detail_view
+      # @param show_detail_view [Boolean] A Boolean
+
+    def show_detail_view=(show_detail_view)
+      if show_detail_view!=nil and ! [true, false].include?show_detail_view
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: show_detail_view EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @show_detail_view = show_detail_view
+      @key_modified['show_detail_view'] = 1
+    end
+
+      # The method to get the unpin_recent_item
+      # @return A String value
+
+    def unpin_recent_item
+      @unpin_recent_item
+    end
+
+      # The method to set the value to unpin_recent_item
+      # @param unpin_recent_item [String] A String
+
+    def unpin_recent_item=(unpin_recent_item)
+      if unpin_recent_item!=nil and !unpin_recent_item.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: unpin_recent_item EXPECTED TYPE: String', nil, nil)
+      end
+      @unpin_recent_item = unpin_recent_item
+      @key_modified['unpin_recent_item'] = 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/users/info.rb

@@ -0,0 +1,118 @@
+require_relative '../util/model'
+
+module Users
+  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