ZOHOCRMSDK2_0_docgo 6.2.0

data/src/com/zoho/crm/api/layouts/layouts_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 Layouts
+    class LayoutsOperations
+
+        # Creates an instance of LayoutsOperations 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 layouts
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_layouts
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = "/crm/v#{Initializer.get_initializer.api_version}/settings/layouts"
+        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.Layouts.GetLayoutsParam'), @module_1)
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
+      end
+
+        # The method to get layout
+        # @param id [Integer] A Integer
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_layout(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/layouts/"
+        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.Layouts.GetLayoutParam'), @module_1)
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
+      end
+
+      class GetLayoutsParam
+      end
+
+      class GetLayoutParam
+      end
+
+    end
+  end
+end

data/src/com/zoho/crm/api/layouts/properties.rb

@@ -0,0 +1,102 @@
+require_relative '../fields/tool_tip'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Layouts
+    class Properties
+      include Util::Model
+
+      # Creates an instance of Properties
+      def initialize
+        @reorder_rows = nil
+        @tooltip = nil
+        @maximum_rows = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the reorder_rows
+        # @return A Boolean value
+
+      def reorder_rows
+        @reorder_rows
+      end
+
+        # The method to set the value to reorder_rows
+        # @param reorder_rows [Boolean] A Boolean
+
+      def reorder_rows=(reorder_rows)
+        if reorder_rows!=nil and ! [true, false].include?reorder_rows
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: reorder_rows EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @reorder_rows = reorder_rows
+        @key_modified['reorder_rows'] = 1
+      end
+
+        # The method to get the tooltip
+        # @return An instance of Fields::ToolTip
+
+      def tooltip
+        @tooltip
+      end
+
+        # The method to set the value to tooltip
+        # @param tooltip [Fields::ToolTip] An instance of Fields::ToolTip
+
+      def tooltip=(tooltip)
+        if tooltip!=nil and !tooltip.is_a? Fields::ToolTip
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: ToolTip', nil, nil)
+        end
+        @tooltip = tooltip
+        @key_modified['tooltip'] = 1
+      end
+
+        # The method to get the maximum_rows
+        # @return A Integer value
+
+      def maximum_rows
+        @maximum_rows
+      end
+
+        # The method to set the value to maximum_rows
+        # @param maximum_rows [Integer] A Integer
+
+      def maximum_rows=(maximum_rows)
+        if maximum_rows!=nil and !maximum_rows.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: maximum_rows EXPECTED TYPE: Integer', nil, nil)
+        end
+        @maximum_rows = maximum_rows
+        @key_modified['maximum_rows'] = 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/layouts/response_handler.rb

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

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

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

@@ -0,0 +1,235 @@
+require_relative '../fields/field'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Layouts
+    class Section
+      include Util::Model
+
+      # Creates an instance of Section
+      def initialize
+        @display_label = nil
+        @sequence_number = nil
+        @issubformsection = nil
+        @tab_traversal = nil
+        @api_name = nil
+        @column_count = nil
+        @name = nil
+        @generated_type = nil
+        @fields = nil
+        @properties = nil
+        @key_modified = Hash.new
+      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 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 issubformsection
+        # @return A Boolean value
+
+      def issubformsection
+        @issubformsection
+      end
+
+        # The method to set the value to issubformsection
+        # @param issubformsection [Boolean] A Boolean
+
+      def issubformsection=(issubformsection)
+        if issubformsection!=nil and ! [true, false].include?issubformsection
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: issubformsection EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @issubformsection = issubformsection
+        @key_modified['isSubformSection'] = 1
+      end
+
+        # The method to get the tab_traversal
+        # @return A Integer value
+
+      def tab_traversal
+        @tab_traversal
+      end
+
+        # The method to set the value to tab_traversal
+        # @param tab_traversal [Integer] A Integer
+
+      def tab_traversal=(tab_traversal)
+        if tab_traversal!=nil and !tab_traversal.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: tab_traversal EXPECTED TYPE: Integer', nil, nil)
+        end
+        @tab_traversal = tab_traversal
+        @key_modified['tab_traversal'] = 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 column_count
+        # @return A Integer value
+
+      def column_count
+        @column_count
+      end
+
+        # The method to set the value to column_count
+        # @param column_count [Integer] A Integer
+
+      def column_count=(column_count)
+        if column_count!=nil and !column_count.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: column_count EXPECTED TYPE: Integer', nil, nil)
+        end
+        @column_count = column_count
+        @key_modified['column_count'] = 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 generated_type
+        # @return A String value
+
+      def generated_type
+        @generated_type
+      end
+
+        # The method to set the value to generated_type
+        # @param generated_type [String] A String
+
+      def generated_type=(generated_type)
+        if generated_type!=nil and !generated_type.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: generated_type EXPECTED TYPE: String', nil, nil)
+        end
+        @generated_type = generated_type
+        @key_modified['generated_type'] = 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 properties
+        # @return An instance of Properties
+
+      def properties
+        @properties
+      end
+
+        # The method to set the value to properties
+        # @param properties [Properties] An instance of Properties
+
+      def properties=(properties)
+        if properties!=nil and !properties.is_a? Properties
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: properties EXPECTED TYPE: Properties', nil, nil)
+        end
+        @properties = properties
+        @key_modified['properties'] = 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/modules/action_handler.rb

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

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

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

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

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

@@ -0,0 +1,127 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Modules
+    require_relative 'response_handler'
+    require_relative 'action_response'
+    require_relative 'action_handler'
+    class APIException
+      include Util::Model
+      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
+end