ZCRMSDK 1.0.2 → 2.1.0

data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb

@@ -0,0 +1,75 @@
+require_relative '../param'
+require_relative '../parameter_map'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module CustomViews
+  class CustomViewsOperations
+
+      # Creates an instance of CustomViewsOperations 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 custom views
+      # @param param_instance [ParameterMap] An instance of ParameterMap
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_custom_views(param_instance=nil)
+      if param_instance!=nil and !param_instance.is_a? ParameterMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/settings/custom_views'
+      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.CustomViews.GetCustomViewsParam'), @module_1)
+      handler_instance.param = param_instance
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+      # The method to get custom view
+      # @param id [Integer] A Integer
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_custom_view(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 = ''
+      api_path = api_path + '/crm/v2/settings/custom_views/'
+      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.CustomViews.GetCustomViewParam'), @module_1)
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+    class GetCustomViewsParam
+      @@page = Param.new('page', 'com.zoho.crm.api.CustomViews.GetCustomViewsParam')
+      def self.page
+        @@page
+      end
+      @@per_page = Param.new('per_page', 'com.zoho.crm.api.CustomViews.GetCustomViewsParam')
+      def self.per_page
+        @@per_page
+      end
+    end
+
+    class GetCustomViewParam
+    end
+
+  end
+end

data/src/com/zoho/crm/api/custom_views/info.rb

@@ -0,0 +1,156 @@
+require_relative '../util/model'
+
+module CustomViews
+  class Info
+    include Util::Model
+
+    # Creates an instance of Info
+    def initialize
+      @per_page = nil
+      @default = nil
+      @count = nil
+      @page = nil
+      @more_records = nil
+      @translation = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the per_page
+      # @return A Integer value
+
+    def per_page
+      @per_page
+    end
+
+      # The method to set the value to per_page
+      # @param per_page [Integer] A Integer
+
+    def per_page=(per_page)
+      if per_page!=nil and !per_page.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: Integer', nil, nil)
+      end
+      @per_page = per_page
+      @key_modified['per_page'] = 1
+    end
+
+      # The method to get the default
+      # @return A String value
+
+    def default
+      @default
+    end
+
+      # The method to set the value to default
+      # @param default [String] A String
+
+    def default=(default)
+      if default!=nil and !default.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: String', nil, nil)
+      end
+      @default = default
+      @key_modified['default'] = 1
+    end
+
+      # The method to get the count
+      # @return A Integer value
+
+    def count
+      @count
+    end
+
+      # The method to set the value to count
+      # @param count [Integer] A Integer
+
+    def count=(count)
+      if count!=nil and !count.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: Integer', nil, nil)
+      end
+      @count = count
+      @key_modified['count'] = 1
+    end
+
+      # The method to get the page
+      # @return A Integer value
+
+    def page
+      @page
+    end
+
+      # The method to set the value to page
+      # @param page [Integer] A Integer
+
+    def page=(page)
+      if page!=nil and !page.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: Integer', nil, nil)
+      end
+      @page = page
+      @key_modified['page'] = 1
+    end
+
+      # The method to get the more_records
+      # @return A Boolean value
+
+    def more_records
+      @more_records
+    end
+
+      # The method to set the value to more_records
+      # @param more_records [Boolean] A Boolean
+
+    def more_records=(more_records)
+      if more_records!=nil and ! [true, false].include?more_records
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: more_records EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @more_records = more_records
+      @key_modified['more_records'] = 1
+    end
+
+      # The method to get the translation
+      # @return An instance of Translation
+
+    def translation
+      @translation
+    end
+
+      # The method to set the value to translation
+      # @param translation [Translation] An instance of Translation
+
+    def translation=(translation)
+      if translation!=nil and !translation.is_a? Translation
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: translation EXPECTED TYPE: Translation', nil, nil)
+      end
+      @translation = translation
+      @key_modified['translation'] = 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/custom_views/range.rb

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

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

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

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

data/src/com/zoho/crm/api/custom_views/shared_details.rb

@@ -0,0 +1,118 @@
+require_relative '../util/model'
+
+module CustomViews
+  class SharedDetails
+    include Util::Model
+
+    # Creates an instance of SharedDetails
+    def initialize
+      @id = nil
+      @name = nil
+      @type = nil
+      @subordinates = 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 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 subordinates
+      # @return A Boolean value
+
+    def subordinates
+      @subordinates
+    end
+
+      # The method to set the value to subordinates
+      # @param subordinates [Boolean] A Boolean
+
+    def subordinates=(subordinates)
+      if subordinates!=nil and ! [true, false].include?subordinates
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: subordinates EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @subordinates = subordinates
+      @key_modified['subordinates'] = 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