ZOHOCRMSDK2_0_docgo 6.2.0

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

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

data/src/com/zoho/crm/api/related_lists/related_list.rb

@@ -0,0 +1,253 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module RelatedLists
+    class RelatedList
+      include Util::Model
+
+      # Creates an instance of RelatedList
+      def initialize
+        @id = nil
+        @sequence_number = nil
+        @display_label = nil
+        @api_name = nil
+        @module_1 = nil
+        @name = nil
+        @action = nil
+        @href = nil
+        @type = nil
+        @connectedmodule = nil
+        @linkingmodule = 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 sequence_number
+        # @return A String value
+
+      def sequence_number
+        @sequence_number
+      end
+
+        # The method to set the value to sequence_number
+        # @param sequence_number [String] A String
+
+      def sequence_number=(sequence_number)
+        if sequence_number!=nil and !sequence_number.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sequence_number EXPECTED TYPE: String', nil, nil)
+        end
+        @sequence_number = sequence_number
+        @key_modified['sequence_number'] = 1
+      end
+
+        # The method to get the display_label
+        # @return A String value
+
+      def display_label
+        @display_label
+      end
+
+        # The method to set the value to display_label
+        # @param display_label [String] A String
+
+      def display_label=(display_label)
+        if display_label!=nil and !display_label.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
+        end
+        @display_label = display_label
+        @key_modified['display_label'] = 1
+      end
+
+        # The method to get the api_name
+        # @return A String value
+
+      def api_name
+        @api_name
+      end
+
+        # The method to set the value to api_name
+        # @param api_name [String] A String
+
+      def api_name=(api_name)
+        if api_name!=nil and !api_name.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: String', nil, nil)
+        end
+        @api_name = api_name
+        @key_modified['api_name'] = 1
+      end
+
+        # The method to get the module
+        # @return A String value
+
+      def module
+        @module_1
+      end
+
+        # The method to set the value to module
+        # @param module_1 [String] A String
+
+      def module=(module_1)
+        if module_1!=nil and !module_1.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
+        end
+        @module_1 = module_1
+        @key_modified['module'] = 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 action
+        # @return A String value
+
+      def action
+        @action
+      end
+
+        # The method to set the value to action
+        # @param action [String] A String
+
+      def action=(action)
+        if action!=nil and !action.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: String', nil, nil)
+        end
+        @action = action
+        @key_modified['action'] = 1
+      end
+
+        # The method to get the href
+        # @return A String value
+
+      def href
+        @href
+      end
+
+        # The method to set the value to href
+        # @param href [String] A String
+
+      def href=(href)
+        if href!=nil and !href.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: href EXPECTED TYPE: String', nil, nil)
+        end
+        @href = href
+        @key_modified['href'] = 1
+      end
+
+        # The method to get the type
+        # @return A String value
+
+      def type
+        @type
+      end
+
+        # The method to set the value to type
+        # @param type [String] A String
+
+      def type=(type)
+        if type!=nil and !type.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
+        end
+        @type = type
+        @key_modified['type'] = 1
+      end
+
+        # The method to get the connectedmodule
+        # @return A String value
+
+      def connectedmodule
+        @connectedmodule
+      end
+
+        # The method to set the value to connectedmodule
+        # @param connectedmodule [String] A String
+
+      def connectedmodule=(connectedmodule)
+        if connectedmodule!=nil and !connectedmodule.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: connectedmodule EXPECTED TYPE: String', nil, nil)
+        end
+        @connectedmodule = connectedmodule
+        @key_modified['connectedmodule'] = 1
+      end
+
+        # The method to get the linkingmodule
+        # @return A String value
+
+      def linkingmodule
+        @linkingmodule
+      end
+
+        # The method to set the value to linkingmodule
+        # @param linkingmodule [String] A String
+
+      def linkingmodule=(linkingmodule)
+        if linkingmodule!=nil and !linkingmodule.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: linkingmodule EXPECTED TYPE: String', nil, nil)
+        end
+        @linkingmodule = linkingmodule
+        @key_modified['linkingmodule'] = 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/related_lists/related_lists_operations.rb

@@ -0,0 +1,61 @@
+require_relative '../param'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module ZOHOCRMSDK
+  module RelatedLists
+    class RelatedListsOperations
+
+        # Creates an instance of RelatedListsOperations with the given parameters
+        # @param module_1 [String] A String
+      def initialize(module_1=nil)
+        if module_1!=nil and !module_1.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
+        end
+        @module_1 = module_1
+      end
+
+        # The method to get related lists
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_related_lists
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = "/crm/v#{Initializer.get_initializer.api_version}/settings/related_lists"
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_GET
+        handler_instance.category_method = 'READ'
+        handler_instance.add_param(Param.new('module', 'com.zoho.crm.api.RelatedLists.GetRelatedListsParam'), @module_1)
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
+      end
+
+        # The method to get related list
+        # @param id [Integer] A Integer
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_related_list(id)
+        if !id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = "/crm/v#{Initializer.get_initializer.api_version}/settings/related_lists/"
+        api_path = api_path + id.to_s
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_GET
+        handler_instance.category_method = 'READ'
+        handler_instance.add_param(Param.new('module', 'com.zoho.crm.api.RelatedLists.GetRelatedListParam'), @module_1)
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
+      end
+
+      class GetRelatedListsParam
+      end
+
+      class GetRelatedListParam
+      end
+
+    end
+  end
+end

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

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

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

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

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

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

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

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

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