ZOHOCRMSDK2_1 1.0.0

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

@@ -0,0 +1,407 @@
+require_relative '../fields/field'
+require_relative '../users/user'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module CustomViews
+    class CustomView
+      include Util::Model
+
+      # Creates an instance of CustomView
+      def initialize
+        @id = nil
+        @name = nil
+        @system_name = nil
+        @display_value = nil
+        @created_time = nil
+        @access_type = nil
+        @category = nil
+        @sort_by = nil
+        @sort_order = nil
+        @favorite = nil
+        @default = nil
+        @system_defined = nil
+        @criteria = nil
+        @shared_to = nil
+        @fields = nil
+        @modified_time = nil
+        @modified_by = nil
+        @last_accessed_time = nil
+        @created_by = 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 system_name
+        # @return A String value
+
+      def system_name
+        @system_name
+      end
+
+        # The method to set the value to system_name
+        # @param system_name [String] A String
+
+      def system_name=(system_name)
+        if system_name!=nil and !system_name.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: system_name EXPECTED TYPE: String', nil, nil)
+        end
+        @system_name = system_name
+        @key_modified['system_name'] = 1
+      end
+
+        # The method to get the display_value
+        # @return A String value
+
+      def display_value
+        @display_value
+      end
+
+        # The method to set the value to display_value
+        # @param display_value [String] A String
+
+      def display_value=(display_value)
+        if display_value!=nil and !display_value.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: String', nil, nil)
+        end
+        @display_value = display_value
+        @key_modified['display_value'] = 1
+      end
+
+        # The method to get the created_time
+        # @return An instance of DateTime
+
+      def created_time
+        @created_time
+      end
+
+        # The method to set the value to created_time
+        # @param created_time [DateTime] An instance of DateTime
+
+      def created_time=(created_time)
+        if created_time!=nil and !created_time.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: DateTime', nil, nil)
+        end
+        @created_time = created_time
+        @key_modified['created_time'] = 1
+      end
+
+        # The method to get the access_type
+        # @return A String value
+
+      def access_type
+        @access_type
+      end
+
+        # The method to set the value to access_type
+        # @param access_type [String] A String
+
+      def access_type=(access_type)
+        if access_type!=nil and !access_type.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: access_type EXPECTED TYPE: String', nil, nil)
+        end
+        @access_type = access_type
+        @key_modified['access_type'] = 1
+      end
+
+        # The method to get the category
+        # @return A String value
+
+      def category
+        @category
+      end
+
+        # The method to set the value to category
+        # @param category [String] A String
+
+      def category=(category)
+        if category!=nil and !category.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: String', nil, nil)
+        end
+        @category = category
+        @key_modified['category'] = 1
+      end
+
+        # The method to get the sort_by
+        # @return A String value
+
+      def sort_by
+        @sort_by
+      end
+
+        # The method to set the value to sort_by
+        # @param sort_by [String] A String
+
+      def sort_by=(sort_by)
+        if sort_by!=nil and !sort_by.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: String', nil, nil)
+        end
+        @sort_by = sort_by
+        @key_modified['sort_by'] = 1
+      end
+
+        # The method to get the sort_order
+        # @return A String value
+
+      def sort_order
+        @sort_order
+      end
+
+        # The method to set the value to sort_order
+        # @param sort_order [String] A String
+
+      def sort_order=(sort_order)
+        if sort_order!=nil and !sort_order.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: String', nil, nil)
+        end
+        @sort_order = sort_order
+        @key_modified['sort_order'] = 1
+      end
+
+        # The method to get the favorite
+        # @return A Integer value
+
+      def favorite
+        @favorite
+      end
+
+        # The method to set the value to favorite
+        # @param favorite [Integer] A Integer
+
+      def favorite=(favorite)
+        if favorite!=nil and !favorite.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: favorite EXPECTED TYPE: Integer', nil, nil)
+        end
+        @favorite = favorite
+        @key_modified['favorite'] = 1
+      end
+
+        # The method to get the default
+        # @return A Boolean value
+
+      def default
+        @default
+      end
+
+        # The method to set the value to default
+        # @param default [Boolean] A Boolean
+
+      def default=(default)
+        if default!=nil and ! [true, false].include?default
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @default = default
+        @key_modified['default'] = 1
+      end
+
+        # The method to get the system_defined
+        # @return A Boolean value
+
+      def system_defined
+        @system_defined
+      end
+
+        # The method to set the value to system_defined
+        # @param system_defined [Boolean] A Boolean
+
+      def system_defined=(system_defined)
+        if system_defined!=nil and ! [true, false].include?system_defined
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: system_defined EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @system_defined = system_defined
+        @key_modified['system_defined'] = 1
+      end
+
+        # The method to get the criteria
+        # @return An instance of Criteria
+
+      def criteria
+        @criteria
+      end
+
+        # The method to set the value to criteria
+        # @param criteria [Criteria] An instance of Criteria
+
+      def criteria=(criteria)
+        if criteria!=nil and !criteria.is_a? Criteria
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', nil, nil)
+        end
+        @criteria = criteria
+        @key_modified['criteria'] = 1
+      end
+
+        # The method to get the shared_to
+        # @return An instance of Array
+
+      def shared_to
+        @shared_to
+      end
+
+        # The method to set the value to shared_to
+        # @param shared_to [Array] An instance of Array
+
+      def shared_to=(shared_to)
+        if shared_to!=nil and !shared_to.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_to EXPECTED TYPE: Array', nil, nil)
+        end
+        @shared_to = shared_to
+        @key_modified['shared_to'] = 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 modified_time
+        # @return An instance of DateTime
+
+      def modified_time
+        @modified_time
+      end
+
+        # The method to set the value to modified_time
+        # @param modified_time [DateTime] An instance of DateTime
+
+      def modified_time=(modified_time)
+        if modified_time!=nil and !modified_time.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: DateTime', nil, nil)
+        end
+        @modified_time = modified_time
+        @key_modified['modified_time'] = 1
+      end
+
+        # The method to get the modified_by
+        # @return An instance of Users::User
+
+      def modified_by
+        @modified_by
+      end
+
+        # The method to set the value to modified_by
+        # @param modified_by [Users::User] An instance of Users::User
+
+      def modified_by=(modified_by)
+        if modified_by!=nil and !modified_by.is_a? Users::User
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', nil, nil)
+        end
+        @modified_by = modified_by
+        @key_modified['modified_by'] = 1
+      end
+
+        # The method to get the last_accessed_time
+        # @return An instance of DateTime
+
+      def last_accessed_time
+        @last_accessed_time
+      end
+
+        # The method to set the value to last_accessed_time
+        # @param last_accessed_time [DateTime] An instance of DateTime
+
+      def last_accessed_time=(last_accessed_time)
+        if last_accessed_time!=nil and !last_accessed_time.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: last_accessed_time EXPECTED TYPE: DateTime', nil, nil)
+        end
+        @last_accessed_time = last_accessed_time
+        @key_modified['last_accessed_time'] = 1
+      end
+
+        # The method to get the created_by
+        # @return An instance of Users::User
+
+      def created_by
+        @created_by
+      end
+
+        # The method to set the value to created_by
+        # @param created_by [Users::User] An instance of Users::User
+
+      def created_by=(created_by)
+        if created_by!=nil and !created_by.is_a? Users::User
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', nil, nil)
+        end
+        @created_by = created_by
+        @key_modified['created_by'] = 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/custom_views_operations.rb

@@ -0,0 +1,77 @@
+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 = ''
+        api_path = api_path + '/crm/v2.1/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.1/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