ZOHOCRMSDK2_0_docgo 6.2.0

data/src/com/zoho/crm/api/query/query_operations.rb

@@ -0,0 +1,36 @@
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module ZOHOCRMSDK
+  module Query
+    class QueryOperations
+
+      # Creates an instance of QueryOperations
+      def initialize
+      end
+
+        # The method to get records
+        # @param request [BodyWrapper] An instance of BodyWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_records(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 = "/crm/v#{Initializer.get_initializer.api_version}/coql"
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_POST
+        handler_instance.category_method = 'CREATE'
+        handler_instance.content_type = 'application/json'
+        handler_instance.request = request
+        handler_instance.mandatory_checker = true
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
+      end
+
+    end
+  end
+end

data/src/com/zoho/crm/api/query/response_handler.rb

@@ -0,0 +1,12 @@
+module ZOHOCRMSDK
+  module Query
+    module ResponseHandler
+
+      # Creates an instance of ResponseHandler
+      def initialize
+      end
+
+
+    end
+  end
+end

data/src/com/zoho/crm/api/query/response_wrapper.rb

@@ -0,0 +1,86 @@
+require_relative '../record/info'
+require_relative '../record/record'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Query
+    require_relative 'response_handler'
+    class ResponseWrapper
+      include Util::Model
+      include ResponseHandler
+
+      # Creates an instance of ResponseWrapper
+      def initialize
+        @data = nil
+        @info = 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 get the info
+        # @return An instance of Record::Info
+
+      def info
+        @info
+      end
+
+        # The method to set the value to info
+        # @param info [Record::Info] An instance of Record::Info
+
+      def info=(info)
+        if info!=nil and !info.is_a? Record::Info
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', nil, nil)
+        end
+        @info = info
+        @key_modified['info'] = 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
+end

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

@@ -0,0 +1,12 @@
+module ZOHOCRMSDK
+  module Record
+    module ActionHandler
+
+      # Creates an instance of ActionHandler
+      def initialize
+      end
+
+
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module ZOHOCRMSDK
+  module Record
+    module ActionResponse
+
+      # Creates an instance of ActionResponse
+      def initialize
+      end
+
+
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Record
+    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
+end

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

@@ -0,0 +1,145 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Record
+    require_relative 'response_handler'
+    require_relative 'action_response'
+    require_relative 'action_handler'
+    require_relative 'deleted_records_handler'
+    require_relative 'convert_action_response'
+    require_relative 'convert_action_handler'
+    require_relative 'download_handler'
+    require_relative 'file_handler'
+    require_relative 'mass_update_action_response'
+    require_relative 'mass_update_action_handler'
+    require_relative 'mass_update_response'
+    require_relative 'mass_update_response_handler'
+    class APIException
+      include Util::Model
+      include ResponseHandler
+      include ActionResponse
+      include ActionHandler
+      include DeletedRecordsHandler
+      include ConvertActionResponse
+      include ConvertActionHandler
+      include DownloadHandler
+      include FileHandler
+      include MassUpdateActionResponse
+      include MassUpdateActionHandler
+      include MassUpdateResponse
+      include MassUpdateResponseHandler
+
+      # 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
+end

data/src/com/zoho/crm/api/record/apply_feature_execution.rb

@@ -0,0 +1,63 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Record
+    class ApplyFeatureExecution
+      include Util::Model
+
+      # Creates an instance of ApplyFeatureExecution
+      def initialize
+        @name = nil
+        @key_modified = Hash.new
+      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
+end

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

@@ -0,0 +1,177 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Record
+    class BodyWrapper
+      include Util::Model
+
+      # Creates an instance of BodyWrapper
+      def initialize
+        @data = nil
+        @apply_feature_execution = nil
+        @trigger = nil
+        @process = nil
+        @duplicate_check_fields = nil
+        @wf_trigger = nil
+        @lar_id = 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 get the apply_feature_execution
+        # @return An instance of Array
+
+      def apply_feature_execution
+        @apply_feature_execution
+      end
+
+        # The method to set the value to apply_feature_execution
+        # @param apply_feature_execution [Array] An instance of Array
+
+      def apply_feature_execution=(apply_feature_execution)
+        if apply_feature_execution!=nil and !apply_feature_execution.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: apply_feature_execution EXPECTED TYPE: Array', nil, nil)
+        end
+        @apply_feature_execution = apply_feature_execution
+        @key_modified['apply_feature_execution'] = 1
+      end
+
+        # The method to get the trigger
+        # @return An instance of Array
+
+      def trigger
+        @trigger
+      end
+
+        # The method to set the value to trigger
+        # @param trigger [Array] An instance of Array
+
+      def trigger=(trigger)
+        if trigger!=nil and !trigger.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: trigger EXPECTED TYPE: Array', nil, nil)
+        end
+        @trigger = trigger
+        @key_modified['trigger'] = 1
+      end
+
+        # The method to get the process
+        # @return An instance of Array
+
+      def process
+        @process
+      end
+
+        # The method to set the value to process
+        # @param process [Array] An instance of Array
+
+      def process=(process)
+        if process!=nil and !process.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: process EXPECTED TYPE: Array', nil, nil)
+        end
+        @process = process
+        @key_modified['process'] = 1
+      end
+
+        # The method to get the duplicate_check_fields
+        # @return An instance of Array
+
+      def duplicate_check_fields
+        @duplicate_check_fields
+      end
+
+        # The method to set the value to duplicate_check_fields
+        # @param duplicate_check_fields [Array] An instance of Array
+
+      def duplicate_check_fields=(duplicate_check_fields)
+        if duplicate_check_fields!=nil and !duplicate_check_fields.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: duplicate_check_fields EXPECTED TYPE: Array', nil, nil)
+        end
+        @duplicate_check_fields = duplicate_check_fields
+        @key_modified['duplicate_check_fields'] = 1
+      end
+
+        # The method to get the wf_trigger
+        # @return A String value
+
+      def wf_trigger
+        @wf_trigger
+      end
+
+        # The method to set the value to wf_trigger
+        # @param wf_trigger [String] A String
+
+      def wf_trigger=(wf_trigger)
+        if wf_trigger!=nil and !wf_trigger.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: wf_trigger EXPECTED TYPE: String', nil, nil)
+        end
+        @wf_trigger = wf_trigger
+        @key_modified['wf_trigger'] = 1
+      end
+
+        # The method to get the lar_id
+        # @return A String value
+
+      def lar_id
+        @lar_id
+      end
+
+        # The method to set the value to lar_id
+        # @param lar_id [String] A String
+
+      def lar_id=(lar_id)
+        if lar_id!=nil and !lar_id.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: lar_id EXPECTED TYPE: String', nil, nil)
+        end
+        @lar_id = lar_id
+        @key_modified['lar_id'] = 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
+end