ZOHOCRMSDK2_0_docgo 6.2.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 ZOHOCRMSDK
+  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 = "/crm/v#{Initializer.get_initializer.api_version}/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 = "/crm/v#{Initializer.get_initializer.api_version}/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
+end

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,21 @@
+require_relative 'datacenter'
+
+module ZOHOCRMSDK
+  module DC
+    class AUDataCenter < DataCenter
+      def initialize; end
+
+      def get_iam_url
+        'https://accounts.zoho.com.au/oauth/v2/token'
+      end
+
+      def get_file_upload_url
+        'https://content.zohoapis.com.au'
+      end
+
+      PRODUCTION = Environment.new('https://www.zohoapis.com.au', AUDataCenter.new.get_iam_url, AUDataCenter.new.get_file_upload_url,"au_prd")
+      SANDBOX = Environment.new('https://sandbox.zohoapis.com.au', AUDataCenter.new.get_iam_url, AUDataCenter.new.get_file_upload_url,"au_sdb")
+      DEVELOPER = Environment.new('https://developer.zohoapis.com.au', AUDataCenter.new.get_iam_url, AUDataCenter.new.get_file_upload_url,"au_dev")
+    end
+  end
+end

data/src/com/zoho/crm/api/dc/cn_datacenter.rb

@@ -0,0 +1,21 @@
+require_relative 'datacenter'
+
+module ZOHOCRMSDK
+  module DC
+    class CNDataCenter < DataCenter
+      def initialize; end
+
+      def get_iam_url
+        'https://accounts.zoho.com.cn/oauth/v2/token'
+      end
+
+      def get_file_upload_url
+        'https://content.zohoapis.com.cn'
+      end
+
+      PRODUCTION = Environment.new('https://www.zohoapis.com.cn', CNDataCenter.new.get_iam_url, CNDataCenter.new.get_file_upload_url,"cn_prd")
+      SANDBOX = Environment.new('https://sandbox.zohoapis.com.cn', CNDataCenter.new.get_iam_url, CNDataCenter.new.get_file_upload_url,"cn_sdb")
+      DEVELOPER = Environment.new('https://developer.zohoapis.com.cn', CNDataCenter.new.get_iam_url, CNDataCenter.new.get_file_upload_url,"cn_dev")
+    end
+  end
+end