ZCRMSDK 2.1.0 → 3.0.0.beta

data/src/com/zoho/crm/api/notification/notification_operations.rb

@@ -22,7 +22,7 @@ module Notification
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/actions/watch'
+      api_path = api_path + '/crm/v2.1/actions/watch'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_POST
       handler_instance.category_method = 'CREATE'
@@ -43,7 +43,7 @@ module Notification
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/actions/watch'
+      api_path = api_path + '/crm/v2.1/actions/watch'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET
       handler_instance.category_method = 'READ'
@@ -62,7 +62,7 @@ module Notification
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/actions/watch'
+      api_path = api_path + '/crm/v2.1/actions/watch'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_PUT
       handler_instance.category_method = 'UPDATE'
@@ -83,7 +83,7 @@ module Notification
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/actions/watch'
+      api_path = api_path + '/crm/v2.1/actions/watch'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_PATCH
       handler_instance.category_method = 'UPDATE'
@@ -104,7 +104,7 @@ module Notification
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/actions/watch'
+      api_path = api_path + '/crm/v2.1/actions/watch'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
       handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
@@ -123,7 +123,7 @@ module Notification
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/actions/watch'
+      api_path = api_path + '/crm/v2.1/actions/watch'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_PATCH
       handler_instance.category_method = 'UPDATE'

data/src/com/zoho/crm/api/org/org_operations.rb

@@ -16,7 +16,7 @@ module Org
     def get_organization
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/org'
+      api_path = api_path + '/crm/v2.1/org'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET
       handler_instance.category_method = 'READ'
@@ -34,7 +34,7 @@ module Org
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/org/photo'
+      api_path = api_path + '/crm/v2.1/org/photo'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_POST
       handler_instance.category_method = 'CREATE'

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

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

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

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

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

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

@@ -0,0 +1,129 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Pipeline
+  require_relative 'transfer_action_response'
+  require_relative 'transfer_action_handler'
+  require_relative 'response_handler'
+  require_relative 'action_response'
+  require_relative 'action_handler'
+  class APIException
+    include Util::Model
+    include TransferActionResponse
+    include TransferActionHandler
+    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/pipeline/body_wrapper.rb

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

@@ -0,0 +1,80 @@
+require_relative '../util/model'
+
+module Pipeline
+  class ForecastCategory
+    include Util::Model
+
+    # Creates an instance of ForecastCategory
+    def initialize
+      @id = nil
+      @name = 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 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/pipeline/pick_list_value.rb

@@ -0,0 +1,175 @@
+require_relative '../util/model'
+
+module Pipeline
+  class PickListValue
+    include Util::Model
+
+    # Creates an instance of PickListValue
+    def initialize
+      @display_value = nil
+      @delete = nil
+      @sequence_number = nil
+      @actual_value = nil
+      @id = nil
+      @forecast_type = nil
+      @forecast_category = nil
+      @key_modified = Hash.new
+    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 delete
+      # @return A Boolean value
+
+    def delete
+      @delete
+    end
+
+      # The method to set the value to delete
+      # @param delete [Boolean] A Boolean
+
+    def delete=(delete)
+      if delete!=nil and ! [true, false].include?delete
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @delete = delete
+      @key_modified['_delete'] = 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 actual_value
+      # @return A String value
+
+    def actual_value
+      @actual_value
+    end
+
+      # The method to set the value to actual_value
+      # @param actual_value [String] A String
+
+    def actual_value=(actual_value)
+      if actual_value!=nil and !actual_value.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: String', nil, nil)
+      end
+      @actual_value = actual_value
+      @key_modified['actual_value'] = 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 forecast_type
+      # @return A String value
+
+    def forecast_type
+      @forecast_type
+    end
+
+      # The method to set the value to forecast_type
+      # @param forecast_type [String] A String
+
+    def forecast_type=(forecast_type)
+      if forecast_type!=nil and !forecast_type.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: forecast_type EXPECTED TYPE: String', nil, nil)
+      end
+      @forecast_type = forecast_type
+      @key_modified['forecast_type'] = 1
+    end
+
+      # The method to get the forecast_category
+      # @return An instance of ForecastCategory
+
+    def forecast_category
+      @forecast_category
+    end
+
+      # The method to set the value to forecast_category
+      # @param forecast_category [ForecastCategory] An instance of ForecastCategory
+
+    def forecast_category=(forecast_category)
+      if forecast_category!=nil and !forecast_category.is_a? ForecastCategory
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: forecast_category EXPECTED TYPE: ForecastCategory', nil, nil)
+      end
+      @forecast_category = forecast_category
+      @key_modified['forecast_category'] = 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