ZCRMSDK 1.0.2 → 3.0.0.beta

data/src/com/zoho/crm/api/currencies/success_response.rb

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Currencies
+  require_relative 'action_response'
+  class SuccessResponse
+    include Util::Model
+    include ActionResponse
+
+    # Creates an instance of SuccessResponse
+    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/custom_views/api_exception.rb

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module CustomViews
+  require_relative 'response_handler'
+  class APIException
+    include Util::Model
+    include ResponseHandler
+
+    # 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/custom_views/criteria.rb

@@ -0,0 +1,136 @@
+require_relative '../fields/field'
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module CustomViews
+  class Criteria
+    include Util::Model
+
+    # Creates an instance of Criteria
+    def initialize
+      @comparator = nil
+      @field = nil
+      @value = nil
+      @group_operator = nil
+      @group = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the comparator
+      # @return An instance of Util::Choice
+
+    def comparator
+      @comparator
+    end
+
+      # The method to set the value to comparator
+      # @param comparator [Util::Choice] An instance of Util::Choice
+
+    def comparator=(comparator)
+      if comparator!=nil and !comparator.is_a? Util::Choice
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: Util::Choice', nil, nil)
+      end
+      @comparator = comparator
+      @key_modified['comparator'] = 1
+    end
+
+      # The method to get the field
+      # @return An instance of Fields::Field
+
+    def field
+      @field
+    end
+
+      # The method to set the value to field
+      # @param field [Fields::Field] An instance of Fields::Field
+
+    def field=(field)
+      if field!=nil and !field.is_a? Fields::Field
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', nil, nil)
+      end
+      @field = field
+      @key_modified['field'] = 1
+    end
+
+      # The method to get the value
+      # @return A lang::Object value
+
+    def value
+      @value
+    end
+
+      # The method to set the value to value
+      # @param value [lang::Object] A lang::Object
+
+    def value=(value)
+      @value = value
+      @key_modified['value'] = 1
+    end
+
+      # The method to get the group_operator
+      # @return An instance of Util::Choice
+
+    def group_operator
+      @group_operator
+    end
+
+      # The method to set the value to group_operator
+      # @param group_operator [Util::Choice] An instance of Util::Choice
+
+    def group_operator=(group_operator)
+      if group_operator!=nil and !group_operator.is_a? Util::Choice
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: Util::Choice', nil, nil)
+      end
+      @group_operator = group_operator
+      @key_modified['group_operator'] = 1
+    end
+
+      # The method to get the group
+      # @return An instance of Array
+
+    def group
+      @group
+    end
+
+      # The method to set the value to group
+      # @param group [Array] An instance of Array
+
+    def group=(group)
+      if group!=nil and !group.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: Array', nil, nil)
+      end
+      @group = group
+      @key_modified['group'] = 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/custom_views/custom_view.rb

@@ -0,0 +1,386 @@
+require_relative '../fields/field'
+require_relative '../users/user'
+require_relative '../util/model'
+
+module CustomViews
+  class CustomView
+    include Util::Model
+
+    # Creates an instance of CustomView
+    def initialize
+      @id = nil
+      @name = nil
+      @system_name = nil
+      @display_value = nil
+      @access_type = nil
+      @category = nil
+      @sort_by = nil
+      @sort_order = nil
+      @favorite = nil
+      @default = nil
+      @system_defined = nil
+      @criteria = nil
+      @shared_to = nil
+      @fields = nil
+      @modified_time = nil
+      @modified_by = nil
+      @last_accessed_time = nil
+      @created_by = nil
+      @key_modified = Hash.new
+    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 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 system_name
+      # @return A String value
+
+    def system_name
+      @system_name
+    end
+
+      # The method to set the value to system_name
+      # @param system_name [String] A String
+
+    def system_name=(system_name)
+      if system_name!=nil and !system_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: system_name EXPECTED TYPE: String', nil, nil)
+      end
+      @system_name = system_name
+      @key_modified['system_name'] = 1
+    end
+
+      # The method to get the display_value
+      # @return A String value
+
+    def display_value
+      @display_value
+    end
+
+      # The method to set the value to display_value
+      # @param display_value [String] A String
+
+    def display_value=(display_value)
+      if display_value!=nil and !display_value.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: String', nil, nil)
+      end
+      @display_value = display_value
+      @key_modified['display_value'] = 1
+    end
+
+      # The method to get the access_type
+      # @return A String value
+
+    def access_type
+      @access_type
+    end
+
+      # The method to set the value to access_type
+      # @param access_type [String] A String
+
+    def access_type=(access_type)
+      if access_type!=nil and !access_type.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: access_type EXPECTED TYPE: String', nil, nil)
+      end
+      @access_type = access_type
+      @key_modified['access_type'] = 1
+    end
+
+      # The method to get the category
+      # @return A String value
+
+    def category
+      @category
+    end
+
+      # The method to set the value to category
+      # @param category [String] A String
+
+    def category=(category)
+      if category!=nil and !category.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: String', nil, nil)
+      end
+      @category = category
+      @key_modified['category'] = 1
+    end
+
+      # The method to get the sort_by
+      # @return A String value
+
+    def sort_by
+      @sort_by
+    end
+
+      # The method to set the value to sort_by
+      # @param sort_by [String] A String
+
+    def sort_by=(sort_by)
+      if sort_by!=nil and !sort_by.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: String', nil, nil)
+      end
+      @sort_by = sort_by
+      @key_modified['sort_by'] = 1
+    end
+
+      # The method to get the sort_order
+      # @return A String value
+
+    def sort_order
+      @sort_order
+    end
+
+      # The method to set the value to sort_order
+      # @param sort_order [String] A String
+
+    def sort_order=(sort_order)
+      if sort_order!=nil and !sort_order.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: String', nil, nil)
+      end
+      @sort_order = sort_order
+      @key_modified['sort_order'] = 1
+    end
+
+      # The method to get the favorite
+      # @return A Integer value
+
+    def favorite
+      @favorite
+    end
+
+      # The method to set the value to favorite
+      # @param favorite [Integer] A Integer
+
+    def favorite=(favorite)
+      if favorite!=nil and !favorite.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: favorite EXPECTED TYPE: Integer', nil, nil)
+      end
+      @favorite = favorite
+      @key_modified['favorite'] = 1
+    end
+
+      # The method to get the default
+      # @return A Boolean value
+
+    def default
+      @default
+    end
+
+      # The method to set the value to default
+      # @param default [Boolean] A Boolean
+
+    def default=(default)
+      if default!=nil and ! [true, false].include?default
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @default = default
+      @key_modified['default'] = 1
+    end
+
+      # The method to get the system_defined
+      # @return A Boolean value
+
+    def system_defined
+      @system_defined
+    end
+
+      # The method to set the value to system_defined
+      # @param system_defined [Boolean] A Boolean
+
+    def system_defined=(system_defined)
+      if system_defined!=nil and ! [true, false].include?system_defined
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: system_defined EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @system_defined = system_defined
+      @key_modified['system_defined'] = 1
+    end
+
+      # The method to get the criteria
+      # @return An instance of Criteria
+
+    def criteria
+      @criteria
+    end
+
+      # The method to set the value to criteria
+      # @param criteria [Criteria] An instance of Criteria
+
+    def criteria=(criteria)
+      if criteria!=nil and !criteria.is_a? 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 shared_to
+      # @return An instance of Array
+
+    def shared_to
+      @shared_to
+    end
+
+      # The method to set the value to shared_to
+      # @param shared_to [Array] An instance of Array
+
+    def shared_to=(shared_to)
+      if shared_to!=nil and !shared_to.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_to EXPECTED TYPE: Array', nil, nil)
+      end
+      @shared_to = shared_to
+      @key_modified['shared_to'] = 1
+    end
+
+      # The method to get the fields
+      # @return An instance of Array
+
+    def fields
+      @fields
+    end
+
+      # The method to set the value to fields
+      # @param fields [Array] An instance of Array
+
+    def fields=(fields)
+      if fields!=nil and !fields.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: Array', nil, nil)
+      end
+      @fields = fields
+      @key_modified['fields'] = 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 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 last_accessed_time
+      # @return An instance of DateTime
+
+    def last_accessed_time
+      @last_accessed_time
+    end
+
+      # The method to set the value to last_accessed_time
+      # @param last_accessed_time [DateTime] An instance of DateTime
+
+    def last_accessed_time=(last_accessed_time)
+      if last_accessed_time!=nil and !last_accessed_time.is_a? DateTime
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: last_accessed_time EXPECTED TYPE: DateTime', nil, nil)
+      end
+      @last_accessed_time = last_accessed_time
+      @key_modified['last_accessed_time'] = 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 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