ZCRMSDK 1.0.5 → 2.0.0

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

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

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

@@ -0,0 +1,123 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module BluePrint
+  require_relative 'response_handler'
+  require_relative 'action_response'
+  class APIException
+    include Util::Model
+    include ResponseHandler
+    include ActionResponse
+
+    # 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/blue_print/blue_print.rb

@@ -0,0 +1,119 @@
+require_relative '../record/record'
+require_relative '../util/model'
+
+module BluePrint
+  class BluePrint
+    include Util::Model
+
+    # Creates an instance of BluePrint
+    def initialize
+      @transition_id = nil
+      @data = nil
+      @process_info = nil
+      @transitions = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the transition_id
+      # @return A Integer value
+
+    def transition_id
+      @transition_id
+    end
+
+      # The method to set the value to transition_id
+      # @param transition_id [Integer] A Integer
+
+    def transition_id=(transition_id)
+      if transition_id!=nil and !transition_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: transition_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      @transition_id = transition_id
+      @key_modified['transition_id'] = 1
+    end
+
+      # The method to get the data
+      # @return An instance of Record::Record
+
+    def data
+      @data
+    end
+
+      # The method to set the value to data
+      # @param data [Record::Record] An instance of Record::Record
+
+    def data=(data)
+      if data!=nil and !data.is_a? Record::Record
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: Record', nil, nil)
+      end
+      @data = data
+      @key_modified['data'] = 1
+    end
+
+      # The method to get the process_info
+      # @return An instance of ProcessInfo
+
+    def process_info
+      @process_info
+    end
+
+      # The method to set the value to process_info
+      # @param process_info [ProcessInfo] An instance of ProcessInfo
+
+    def process_info=(process_info)
+      if process_info!=nil and !process_info.is_a? ProcessInfo
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: process_info EXPECTED TYPE: ProcessInfo', nil, nil)
+      end
+      @process_info = process_info
+      @key_modified['process_info'] = 1
+    end
+
+      # The method to get the transitions
+      # @return An instance of Array
+
+    def transitions
+      @transitions
+    end
+
+      # The method to set the value to transitions
+      # @param transitions [Array] An instance of Array
+
+    def transitions=(transitions)
+      if transitions!=nil and !transitions.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: transitions EXPECTED TYPE: Array', nil, nil)
+      end
+      @transitions = transitions
+      @key_modified['transitions'] = 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/blue_print/blue_print_operations.rb

@@ -0,0 +1,67 @@
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module BluePrint
+  class BluePrintOperations
+
+      # Creates an instance of BluePrintOperations with the given parameters
+      # @param record_id [Integer] A Integer
+      # @param module_api_name [String] A String
+    def initialize(record_id, module_api_name)
+      if !record_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      if !module_api_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
+      end
+      @record_id = record_id
+      @module_api_name = module_api_name
+    end
+
+      # The method to get blueprint
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_blueprint
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/'
+      api_path = api_path + @module_api_name.to_s
+      api_path = api_path + '/'
+      api_path = api_path + @record_id.to_s
+      api_path = api_path + '/actions/blueprint'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_GET
+      handler_instance.category_method = 'READ'
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+      # The method to update blueprint
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def update_blueprint(request)
+      if request!=nil and !request.is_a? BodyWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/'
+      api_path = api_path + @module_api_name.to_s
+      api_path = api_path + '/'
+      api_path = api_path + @record_id.to_s
+      api_path = api_path + '/actions/blueprint'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_PUT
+      handler_instance.category_method = 'UPDATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      handler_instance.mandatory_checker = true
+      require_relative 'action_response'
+      handler_instance.api_call(ActionResponse.name, 'application/json')
+    end
+
+  end
+end

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

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

@@ -0,0 +1,80 @@
+require_relative '../util/model'
+
+module BluePrint
+  class NextTransition
+    include Util::Model
+
+    # Creates an instance of NextTransition
+    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