ZOHOCRMSDK2_0 1.0.0 → 5.0.0

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

@@ -5,108 +5,110 @@ require_relative '../util/api_response'
 require_relative '../util/common_api_handler'
 require_relative '../util/constants'
 
-module BulkWrite
-  class BulkWriteOperations
+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)
+      # Creates an instance of BulkWriteOperations
+      def initialize
       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)
+        # 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
-      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)
+        # 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
-      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)
+        # 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
-      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
+        # 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
-      @@X_crm_org = Header.new('X-CRM-ORG', 'com.zoho.crm.api.BulkWrite.UploadFileHeader')
-      def self.X_crm_org
-        @@X_crm_org
+
+      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
 end

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

@@ -1,216 +1,218 @@
 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
+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 set the value to status
-      # @param status [String] A String
+        # The method to get the status
+        # @return A String value
 
-    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)
+      def status
+        @status
       end
-      @status = status
-      @key_modified['status'] = 1
-    end
 
-      # The method to get the character_encoding
-      # @return A String value
+        # The method to set the value to status
+        # @param status [String] A String
 
-    def character_encoding
-      @character_encoding
-    end
+      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 set the value to character_encoding
-      # @param character_encoding [String] A String
+        # The method to get the character_encoding
+        # @return A String value
 
-    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)
+      def character_encoding
+        @character_encoding
       end
-      @character_encoding = character_encoding
-      @key_modified['character_encoding'] = 1
-    end
 
-      # The method to get the resource
-      # @return An instance of Array
+        # The method to set the value to character_encoding
+        # @param character_encoding [String] A String
 
-    def resource
-      @resource
-    end
+      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 set the value to resource
-      # @param resource [Array] An instance of Array
+        # The method to get the resource
+        # @return 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)
+      def resource
+        @resource
       end
-      @resource = resource
-      @key_modified['resource'] = 1
-    end
 
-      # The method to get the id
-      # @return A Integer value
+        # The method to set the value to resource
+        # @param resource [Array] An instance of Array
 
-    def id
-      @id
-    end
+      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 set the value to id
-      # @param id [Integer] A Integer
+        # The method to get the id
+        # @return A Integer value
 
-    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)
+      def id
+        @id
       end
-      @id = id
-      @key_modified['id'] = 1
-    end
 
-      # The method to get the callback
-      # @return An instance of CallBack
+        # The method to set the value to id
+        # @param id [Integer] A Integer
 
-    def callback
-      @callback
-    end
+      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 set the value to callback
-      # @param callback [CallBack] An instance of CallBack
+        # The method to get the callback
+        # @return 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)
+      def callback
+        @callback
       end
-      @callback = callback
-      @key_modified['callback'] = 1
-    end
 
-      # The method to get the result
-      # @return An instance of Result
+        # The method to set the value to callback
+        # @param callback [CallBack] An instance of CallBack
 
-    def result
-      @result
-    end
+      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 set the value to result
-      # @param result [Result] An instance of Result
+        # The method to get the result
+        # @return 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)
+      def result
+        @result
       end
-      @result = result
-      @key_modified['result'] = 1
-    end
 
-      # The method to get the created_by
-      # @return An instance of Users::User
+        # The method to set the value to result
+        # @param result [Result] An instance of Result
 
-    def created_by
-      @created_by
-    end
+      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 set the value to created_by
-      # @param created_by [Users::User] An instance of Users::User
+        # The method to get the created_by
+        # @return 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)
+      def created_by
+        @created_by
       end
-      @created_by = created_by
-      @key_modified['created_by'] = 1
-    end
 
-      # The method to get the operation
-      # @return A String value
+        # The method to set the value to created_by
+        # @param created_by [Users::User] An instance of Users::User
 
-    def operation
-      @operation
-    end
+      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 set the value to operation
-      # @param operation [String] A String
+        # The method to get the operation
+        # @return A String value
 
-    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)
+      def operation
+        @operation
       end
-      @operation = operation
-      @key_modified['operation'] = 1
-    end
 
-      # The method to get the created_time
-      # @return An instance of DateTime
+        # The method to set the value to operation
+        # @param operation [String] A String
 
-    def created_time
-      @created_time
-    end
+      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 set the value to created_time
-      # @param created_time [DateTime] An instance of DateTime
+        # The method to get the created_time
+        # @return 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)
+      def created_time
+        @created_time
       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
+        # The method to set the value to created_time
+        # @param created_time [DateTime] An instance of DateTime
 
-    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]
+      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
 
-      nil
-    end
+        # The method to check if the user has modified the given key
+        # @param key [String] A String
+        # @return A Integer value
 
-      # The method to mark the given key as modified
-      # @param key [String] A String
-      # @param modification [Integer] A Integer
+      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
 
-    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)
+        nil
       end
-      if modification!=nil and !modification.is_a? Integer
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+
+        # 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
-      @key_modified[key] = modification
-    end
 
+    end
   end
 end