ZOHOCRMSDK5_0 1.0.0

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

@@ -0,0 +1,127 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module BulkRead
+    require_relative 'action_response'
+    require_relative 'action_handler'
+    require_relative 'response_handler'
+    class APIException
+      include Util::Model
+      include ActionResponse
+      include ActionHandler
+      include ResponseHandler
+
+      # Creates an instance of APIException
+      def initialize
+        @code = nil
+        @details = nil
+        @message = nil
+        @status = nil
+        @key_modified = Hash.new
+      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 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 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 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 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/bulk_read_operations.rb

@@ -0,0 +1,76 @@
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module ZOHOCRMSDK
+  module BulkRead
+    class BulkReadOperations
+
+      # Creates an instance of BulkReadOperations
+      def initialize
+      end
+
+        # The method to create bulk read job
+        # @param request [RequestWrapper] An instance of RequestWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def create_bulk_read_job(request)
+        if request!=nil and !request.is_a? RequestWrapper
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: RequestWrapper', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/crm/bulk/v5/read'
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_POST
+        handler_instance.category_method = 'CREATE'
+        handler_instance.content_type = 'application/json'
+        handler_instance.request = request
+        handler_instance.mandatory_checker = true
+        require_relative 'action_handler'
+        handler_instance.api_call(ActionHandler.name, 'application/json')
+      end
+
+        # The method to get bulk read job details
+        # @param job_id [Integer] A Integer
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_bulk_read_job_details(job_id)
+        if !job_id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: Integer', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/crm/bulk/v5/read/'
+        api_path = api_path + job_id.to_s
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_GET
+        handler_instance.category_method = 'READ'
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
+      end
+
+        # The method to download result
+        # @param job_id [Integer] A Integer
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def download_result(job_id)
+        if !job_id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: Integer', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/crm/bulk/v5/read/'
+        api_path = api_path + job_id.to_s
+        api_path = api_path + '/result'
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_GET
+        handler_instance.category_method = 'READ'
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/x-download')
+      end
+
+    end
+  end
+end

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

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

@@ -0,0 +1,157 @@
+require_relative '../fields/minified_field'
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module BulkRead
+    class Criteria
+      include Util::Model
+
+      # Creates an instance of Criteria
+      def initialize
+        @api_name = nil
+        @value = nil
+        @group_operator = nil
+        @group = nil
+        @field = nil
+        @comparator = nil
+        @key_modified = Hash.new
+      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 value
+        # @return A lang::Object value
+
+      def value
+        @value
+      end
+
+        # The method to set the value to value
+        # @param value [lang::Object] A lang::Object
+
+      def value=(value)
+        @value = value
+        @key_modified['value'] = 1
+      end
+
+        # The method to get the group_operator
+        # @return An instance of Util::Choice
+
+      def group_operator
+        @group_operator
+      end
+
+        # The method to set the value to group_operator
+        # @param group_operator [Util::Choice] An instance of Util::Choice
+
+      def group_operator=(group_operator)
+        if group_operator!=nil and !group_operator.is_a? Util::Choice
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: Util::Choice', nil, nil)
+        end
+        @group_operator = group_operator
+        @key_modified['group_operator'] = 1
+      end
+
+        # The method to get the group
+        # @return An instance of Array
+
+      def group
+        @group
+      end
+
+        # The method to set the value to group
+        # @param group [Array] An instance of Array
+
+      def group=(group)
+        if group!=nil and !group.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: Array', nil, nil)
+        end
+        @group = group
+        @key_modified['group'] = 1
+      end
+
+        # The method to get the field
+        # @return An instance of Fields::MinifiedField
+
+      def field
+        @field
+      end
+
+        # The method to set the value to field
+        # @param field [Fields::MinifiedField] An instance of Fields::MinifiedField
+
+      def field=(field)
+        if field!=nil and !field.is_a? Fields::MinifiedField
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: MinifiedField', nil, nil)
+        end
+        @field = field
+        @key_modified['field'] = 1
+      end
+
+        # The method to get the comparator
+        # @return An instance of Util::Choice
+
+      def comparator
+        @comparator
+      end
+
+        # The method to set the value to comparator
+        # @param comparator [Util::Choice] An instance of Util::Choice
+
+      def comparator=(comparator)
+        if comparator!=nil and !comparator.is_a? Util::Choice
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: Util::Choice', nil, nil)
+        end
+        @comparator = comparator
+        @key_modified['comparator'] = 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/file_body_wrapper.rb

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

@@ -0,0 +1,198 @@
+require_relative '../users/minified_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 String value
+
+      def id
+        @id
+      end
+
+        # The method to set the value to id
+        # @param id [String] A String
+
+      def id=(id)
+        if id!=nil and !id.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: String', 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::MinifiedUser
+
+      def created_by
+        @created_by
+      end
+
+        # The method to set the value to created_by
+        # @param created_by [Users::MinifiedUser] An instance of Users::MinifiedUser
+
+      def created_by=(created_by)
+        if created_by!=nil and !created_by.is_a? Users::MinifiedUser
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', 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 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