ZOHOCRMSDK2_0_docgo 6.2.0

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

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

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

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

@@ -0,0 +1,241 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module BulkWrite
+    require_relative 'action_response'
+    require_relative 'response_wrapper'
+    require_relative 'response_handler'
+    class APIException
+      include Util::Model
+      include ActionResponse
+      include ResponseWrapper
+      include ResponseHandler
+
+      # Creates an instance of APIException
+      def initialize
+        @code = nil
+        @message = nil
+        @status = nil
+        @details = nil
+        @error_message = nil
+        @error_code = nil
+        @x_error = nil
+        @info = nil
+        @x_info = nil
+        @http_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 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 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 error_message
+        # @return An instance of Util::Choice
+
+      def error_message
+        @error_message
+      end
+
+        # The method to set the value to error_message
+        # @param error_message [Util::Choice] An instance of Util::Choice
+
+      def error_message=(error_message)
+        if error_message!=nil and !error_message.is_a? Util::Choice
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: error_message EXPECTED TYPE: Util::Choice', nil, nil)
+        end
+        @error_message = error_message
+        @key_modified['ERROR_MESSAGE'] = 1
+      end
+
+        # The method to get the error_code
+        # @return A Integer value
+
+      def error_code
+        @error_code
+      end
+
+        # The method to set the value to error_code
+        # @param error_code [Integer] A Integer
+
+      def error_code=(error_code)
+        if error_code!=nil and !error_code.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: error_code EXPECTED TYPE: Integer', nil, nil)
+        end
+        @error_code = error_code
+        @key_modified['ERROR_CODE'] = 1
+      end
+
+        # The method to get the x_error
+        # @return An instance of Util::Choice
+
+      def x_error
+        @x_error
+      end
+
+        # The method to set the value to x_error
+        # @param x_error [Util::Choice] An instance of Util::Choice
+
+      def x_error=(x_error)
+        if x_error!=nil and !x_error.is_a? Util::Choice
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: x_error EXPECTED TYPE: Util::Choice', nil, nil)
+        end
+        @x_error = x_error
+        @key_modified['x-error'] = 1
+      end
+
+        # The method to get the info
+        # @return An instance of Util::Choice
+
+      def info
+        @info
+      end
+
+        # The method to set the value to info
+        # @param info [Util::Choice] An instance of Util::Choice
+
+      def info=(info)
+        if info!=nil and !info.is_a? Util::Choice
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Util::Choice', nil, nil)
+        end
+        @info = info
+        @key_modified['info'] = 1
+      end
+
+        # The method to get the x_info
+        # @return An instance of Util::Choice
+
+      def x_info
+        @x_info
+      end
+
+        # The method to set the value to x_info
+        # @param x_info [Util::Choice] An instance of Util::Choice
+
+      def x_info=(x_info)
+        if x_info!=nil and !x_info.is_a? Util::Choice
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: x_info EXPECTED TYPE: Util::Choice', nil, nil)
+        end
+        @x_info = x_info
+        @key_modified['x-info'] = 1
+      end
+
+        # The method to get the http_status
+        # @return A String value
+
+      def http_status
+        @http_status
+      end
+
+        # The method to set the value to http_status
+        # @param http_status [String] A String
+
+      def http_status=(http_status)
+        if http_status!=nil and !http_status.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: http_status EXPECTED TYPE: String', nil, nil)
+        end
+        @http_status = http_status
+        @key_modified['http_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_write/bulk_write_operations.rb

@@ -0,0 +1,114 @@
+require_relative '../header'
+require_relative '../header_map'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module ZOHOCRMSDK
+  module BulkWrite
+    class BulkWriteOperations
+
+      # Creates an instance of BulkWriteOperations
+      def initialize
+      end
+
+        # The method to upload file
+        # @param request [FileBodyWrapper] An instance of FileBodyWrapper
+        # @param header_instance [HeaderMap] An instance of HeaderMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def upload_file(request, header_instance=nil)
+        if request!=nil and !request.is_a? FileBodyWrapper
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', nil, nil)
+        end
+        if header_instance!=nil and !header_instance.is_a? HeaderMap
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + 'https://content.zohoapis.com/crm/v2/upload'
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_POST
+        handler_instance.category_method = 'CREATE'
+        handler_instance.content_type = 'multipart/form-data'
+        handler_instance.request = request
+        handler_instance.mandatory_checker = true
+        handler_instance.header = header_instance
+        require_relative 'action_response'
+        handler_instance.api_call(ActionResponse.name, 'application/json')
+      end
+
+        # The method to create bulk write job
+        # @param request [RequestWrapper] An instance of RequestWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def create_bulk_write_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/v2/write'
+        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_response'
+        handler_instance.api_call(ActionResponse.name, 'application/json')
+      end
+
+        # The method to get bulk write job details
+        # @param job_id [Integer] A Integer
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_bulk_write_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/v2/write/'
+        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_wrapper'
+        handler_instance.api_call(ResponseWrapper.name, 'application/json')
+      end
+
+        # The method to download bulk write result
+        # @param download_url [String] A String
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def download_bulk_write_result(download_url)
+        if !download_url.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: download_url EXPECTED TYPE: String', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/'
+        api_path = api_path + download_url.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/octet-stream')
+      end
+
+      class UploadFileHeader
+          @@feature =   Header.new('feature', 'com.zoho.crm.api.BulkWrite.UploadFileHeader')
+        def self.feature
+          @@feature
+        end
+          @@X_crm_org =   Header.new('X-CRM-ORG', 'com.zoho.crm.api.BulkWrite.UploadFileHeader')
+        def self.X_crm_org
+          @@X_crm_org
+        end
+      end
+
+    end
+  end
+end

data/src/com/zoho/crm/api/bulk_write/bulk_write_response.rb

@@ -0,0 +1,218 @@
+require_relative '../users/user'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module BulkWrite
+    require_relative 'response_wrapper'
+    class BulkWriteResponse
+      include Util::Model
+      include ResponseWrapper
+
+      # Creates an instance of BulkWriteResponse
+      def initialize
+        @status = nil
+        @character_encoding = nil
+        @resource = nil
+        @id = nil
+        @callback = nil
+        @result = nil
+        @created_by = nil
+        @operation = nil
+        @created_time = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the status
+        # @return A String value
+
+      def status
+        @status
+      end
+
+        # The method to set the value to status
+        # @param status [String] A String
+
+      def status=(status)
+        if status!=nil and !status.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: String', nil, nil)
+        end
+        @status = status
+        @key_modified['status'] = 1
+      end
+
+        # The method to get the character_encoding
+        # @return A String value
+
+      def character_encoding
+        @character_encoding
+      end
+
+        # The method to set the value to character_encoding
+        # @param character_encoding [String] A String
+
+      def character_encoding=(character_encoding)
+        if character_encoding!=nil and !character_encoding.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: character_encoding EXPECTED TYPE: String', nil, nil)
+        end
+        @character_encoding = character_encoding
+        @key_modified['character_encoding'] = 1
+      end
+
+        # The method to get the resource
+        # @return An instance of Array
+
+      def resource
+        @resource
+      end
+
+        # The method to set the value to resource
+        # @param resource [Array] An instance of Array
+
+      def resource=(resource)
+        if resource!=nil and !resource.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: resource EXPECTED TYPE: Array', nil, nil)
+        end
+        @resource = resource
+        @key_modified['resource'] = 1
+      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 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 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 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 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 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 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