ZOHOCRMSDK2_0_docgo 6.2.0

data/src/com/zoho/crm/api/bulk_read/job_detail.rb

@@ -0,0 +1,198 @@
+require_relative '../users/user'
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module BulkRead
+    class JobDetail
+      include Util::Model
+
+      # Creates an instance of JobDetail
+      def initialize
+        @id = nil
+        @operation = nil
+        @state = nil
+        @query = nil
+        @created_by = nil
+        @created_time = nil
+        @result = nil
+        @file_type = 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 operation
+        # @return A String value
+
+      def operation
+        @operation
+      end
+
+        # The method to set the value to operation
+        # @param operation [String] A String
+
+      def operation=(operation)
+        if operation!=nil and !operation.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: operation EXPECTED TYPE: String', nil, nil)
+        end
+        @operation = operation
+        @key_modified['operation'] = 1
+      end
+
+        # The method to get the state
+        # @return An instance of Util::Choice
+
+      def state
+        @state
+      end
+
+        # The method to set the value to state
+        # @param state [Util::Choice] An instance of Util::Choice
+
+      def state=(state)
+        if state!=nil and !state.is_a? Util::Choice
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: Util::Choice', nil, nil)
+        end
+        @state = state
+        @key_modified['state'] = 1
+      end
+
+        # The method to get the query
+        # @return An instance of Query
+
+      def query
+        @query
+      end
+
+        # The method to set the value to query
+        # @param query [Query] An instance of Query
+
+      def query=(query)
+        if query!=nil and !query.is_a? Query
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: query EXPECTED TYPE: Query', nil, nil)
+        end
+        @query = query
+        @key_modified['query'] = 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 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 result
+        # @return An instance of Result
+
+      def result
+        @result
+      end
+
+        # The method to set the value to result
+        # @param result [Result] An instance of Result
+
+      def result=(result)
+        if result!=nil and !result.is_a? Result
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: result EXPECTED TYPE: Result', nil, nil)
+        end
+        @result = result
+        @key_modified['result'] = 1
+      end
+
+        # The method to get the file_type
+        # @return A String value
+
+      def file_type
+        @file_type
+      end
+
+        # The method to set the value to file_type
+        # @param file_type [String] A String
+
+      def file_type=(file_type)
+        if file_type!=nil and !file_type.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: file_type EXPECTED TYPE: String', nil, nil)
+        end
+        @file_type = file_type
+        @key_modified['file_type'] = 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/bulk_read/query.rb

@@ -0,0 +1,139 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module BulkRead
+    class Query
+      include Util::Model
+
+      # Creates an instance of Query
+      def initialize
+        @module_1 = nil
+        @cvid = nil
+        @fields = nil
+        @page = nil
+        @criteria = nil
+        @key_modified = Hash.new
+      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 cvid
+        # @return A String value
+
+      def cvid
+        @cvid
+      end
+
+        # The method to set the value to cvid
+        # @param cvid [String] A String
+
+      def cvid=(cvid)
+        if cvid!=nil and !cvid.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: cvid EXPECTED TYPE: String', nil, nil)
+        end
+        @cvid = cvid
+        @key_modified['cvid'] = 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 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 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 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/bulk_read/request_wrapper.rb

@@ -0,0 +1,102 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module BulkRead
+    class RequestWrapper
+      include Util::Model
+
+      # Creates an instance of RequestWrapper
+      def initialize
+        @callback = nil
+        @query = nil
+        @file_type = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the callback
+        # @return An instance of CallBack
+
+      def callback
+        @callback
+      end
+
+        # The method to set the value to callback
+        # @param callback [CallBack] An instance of CallBack
+
+      def callback=(callback)
+        if callback!=nil and !callback.is_a? CallBack
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: callback EXPECTED TYPE: CallBack', nil, nil)
+        end
+        @callback = callback
+        @key_modified['callback'] = 1
+      end
+
+        # The method to get the query
+        # @return An instance of Query
+
+      def query
+        @query
+      end
+
+        # The method to set the value to query
+        # @param query [Query] An instance of Query
+
+      def query=(query)
+        if query!=nil and !query.is_a? Query
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: query EXPECTED TYPE: Query', nil, nil)
+        end
+        @query = query
+        @key_modified['query'] = 1
+      end
+
+        # The method to get the file_type
+        # @return An instance of Util::Choice
+
+      def file_type
+        @file_type
+      end
+
+        # The method to set the value to file_type
+        # @param file_type [Util::Choice] An instance of Util::Choice
+
+      def file_type=(file_type)
+        if file_type!=nil and !file_type.is_a? Util::Choice
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: file_type EXPECTED TYPE: Util::Choice', nil, nil)
+        end
+        @file_type = file_type
+        @key_modified['file_type'] = 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/bulk_read/response_handler.rb

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

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

@@ -0,0 +1,65 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module BulkRead
+    require_relative 'response_handler'
+    class ResponseWrapper
+      include Util::Model
+      include ResponseHandler
+
+      # Creates an instance of ResponseWrapper
+      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

data/src/com/zoho/crm/api/bulk_read/result.rb

@@ -0,0 +1,139 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module BulkRead
+    class Result
+      include Util::Model
+
+      # Creates an instance of Result
+      def initialize
+        @page = nil
+        @count = nil
+        @download_url = nil
+        @per_page = nil
+        @more_records = nil
+        @key_modified = Hash.new
+      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 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 download_url
+        # @return A String value
+
+      def download_url
+        @download_url
+      end
+
+        # The method to set the value to download_url
+        # @param download_url [String] A String
+
+      def download_url=(download_url)
+        if download_url!=nil and !download_url.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: download_url EXPECTED TYPE: String', nil, nil)
+        end
+        @download_url = download_url
+        @key_modified['download_url'] = 1
+      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 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 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