ZCRMSDK 1.0.4 → 3.0.0

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

@@ -0,0 +1,112 @@
+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 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.1/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.1/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.1/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

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

@@ -0,0 +1,216 @@
+require_relative '../users/user'
+require_relative '../util/model'
+
+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

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

@@ -0,0 +1,81 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module BulkWrite
+  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

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

@@ -0,0 +1,156 @@
+require_relative '../util/model'
+
+module BulkWrite
+  class FieldMapping
+    include Util::Model
+
+    # Creates an instance of FieldMapping
+    def initialize
+      @api_name = nil
+      @index = nil
+      @format = nil
+      @find_by = nil
+      @default_value = nil
+      @module_1 = 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 index
+      # @return A Integer value
+
+    def index
+      @index
+    end
+
+      # The method to set the value to index
+      # @param index [Integer] A Integer
+
+    def index=(index)
+      if index!=nil and !index.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: index EXPECTED TYPE: Integer', nil, nil)
+      end
+      @index = index
+      @key_modified['index'] = 1
+    end
+
+      # The method to get the format
+      # @return A String value
+
+    def format
+      @format
+    end
+
+      # The method to set the value to format
+      # @param format [String] A String
+
+    def format=(format)
+      if format!=nil and !format.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: format EXPECTED TYPE: String', nil, nil)
+      end
+      @format = format
+      @key_modified['format'] = 1
+    end
+
+      # The method to get the find_by
+      # @return A String value
+
+    def find_by
+      @find_by
+    end
+
+      # The method to set the value to find_by
+      # @param find_by [String] A String
+
+    def find_by=(find_by)
+      if find_by!=nil and !find_by.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: find_by EXPECTED TYPE: String', nil, nil)
+      end
+      @find_by = find_by
+      @key_modified['find_by'] = 1
+    end
+
+      # The method to get the default_value
+      # @return An instance of Hash
+
+    def default_value
+      @default_value
+    end
+
+      # The method to set the value to default_value
+      # @param default_value [Hash] An instance of Hash
+
+    def default_value=(default_value)
+      if default_value!=nil and !default_value.is_a? Hash
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: Hash', nil, nil)
+      end
+      @default_value = default_value
+      @key_modified['default_value'] = 1
+    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 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