ZOHOCRMSDK2_0_docgo 6.2.0

data/src/com/zoho/crm/api/notes/notes_operations.rb

@@ -0,0 +1,214 @@
+require_relative '../header'
+require_relative '../header_map'
+require_relative '../param'
+require_relative '../parameter_map'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module ZOHOCRMSDK
+  module Notes
+    class NotesOperations
+
+      # Creates an instance of NotesOperations
+      def initialize
+      end
+
+        # The method to get notes
+        # @param param_instance [ParameterMap] An instance of ParameterMap
+        # @param header_instance [HeaderMap] An instance of HeaderMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_notes(param_instance=nil, header_instance=nil)
+        if param_instance!=nil and !param_instance.is_a? ParameterMap
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', 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 = "/crm/v#{Initializer.get_initializer.api_version}/Notes"
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_GET
+        handler_instance.category_method = 'READ'
+        handler_instance.param = param_instance
+        handler_instance.header = header_instance
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
+      end
+
+        # The method to create notes
+        # @param request [BodyWrapper] An instance of BodyWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def create_notes(request)
+        if request!=nil and !request.is_a? BodyWrapper
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = "/crm/v#{Initializer.get_initializer.api_version}/Notes"
+        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 update notes
+        # @param request [BodyWrapper] An instance of BodyWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def update_notes(request)
+        if request!=nil and !request.is_a? BodyWrapper
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = "/crm/v#{Initializer.get_initializer.api_version}/Notes"
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_PUT
+        handler_instance.category_method = 'UPDATE'
+        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 delete notes
+        # @param param_instance [ParameterMap] An instance of ParameterMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def delete_notes(param_instance=nil)
+        if param_instance!=nil and !param_instance.is_a? ParameterMap
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = "/crm/v#{Initializer.get_initializer.api_version}/Notes"
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
+        handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
+        handler_instance.param = param_instance
+        require_relative 'action_handler'
+        handler_instance.api_call(ActionHandler.name, 'application/json')
+      end
+
+        # The method to get note
+        # @param id [Integer] A Integer
+        # @param param_instance [ParameterMap] An instance of ParameterMap
+        # @param header_instance [HeaderMap] An instance of HeaderMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_note(id, param_instance=nil, header_instance=nil)
+        if !id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+        end
+        if param_instance!=nil and !param_instance.is_a? ParameterMap
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', 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 = "/crm/v#{Initializer.get_initializer.api_version}/Notes/"
+        api_path = api_path + id.to_s
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_GET
+        handler_instance.category_method = 'READ'
+        handler_instance.param = param_instance
+        handler_instance.header = header_instance
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
+      end
+
+        # The method to update note
+        # @param id [Integer] A Integer
+        # @param request [BodyWrapper] An instance of BodyWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def update_note(id, request)
+        if !id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+        end
+        if request!=nil and !request.is_a? BodyWrapper
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = "/crm/v#{Initializer.get_initializer.api_version}/Notes/"
+        api_path = api_path + id.to_s
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_PUT
+        handler_instance.category_method = 'UPDATE'
+        handler_instance.content_type = 'application/json'
+        handler_instance.request = request
+        require_relative 'action_handler'
+        handler_instance.api_call(ActionHandler.name, 'application/json')
+      end
+
+        # The method to delete note
+        # @param id [Integer] A Integer
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def delete_note(id)
+        if !id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = "/crm/v#{Initializer.get_initializer.api_version}/Notes/"
+        api_path = api_path + id.to_s
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
+        handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
+        require_relative 'action_handler'
+        handler_instance.api_call(ActionHandler.name, 'application/json')
+      end
+
+      class GetNotesParam
+          @@page =   Param.new('page', 'com.zoho.crm.api.Notes.GetNotesParam')
+        def self.page
+          @@page
+        end
+          @@per_page =   Param.new('per_page', 'com.zoho.crm.api.Notes.GetNotesParam')
+        def self.per_page
+          @@per_page
+        end
+          @@fields =   Param.new('fields', 'com.zoho.crm.api.Notes.GetNotesParam')
+        def self.fields
+          @@fields
+        end
+      end
+
+      class GetNotesHeader
+          @@If_modified_since =   Header.new('If-Modified-Since', 'com.zoho.crm.api.Notes.GetNotesHeader')
+        def self.If_modified_since
+          @@If_modified_since
+        end
+      end
+
+      class DeleteNotesParam
+          @@ids =   Param.new('ids', 'com.zoho.crm.api.Notes.DeleteNotesParam')
+        def self.ids
+          @@ids
+        end
+      end
+
+      class GetNoteParam
+          @@fields =   Param.new('fields', 'com.zoho.crm.api.Notes.GetNoteParam')
+        def self.fields
+          @@fields
+        end
+      end
+
+      class GetNoteHeader
+          @@If_modified_since =   Header.new('If-Modified-Since', 'com.zoho.crm.api.Notes.GetNoteHeader')
+        def self.If_modified_since
+          @@If_modified_since
+        end
+      end
+
+    end
+  end
+end

data/src/com/zoho/crm/api/notes/response_handler.rb

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

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

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

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

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

data/src/com/zoho/crm/api/notification/action_response.rb

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

data/src/com/zoho/crm/api/notification/action_wrapper.rb

@@ -0,0 +1,65 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Notification
+    require_relative 'action_handler'
+    class ActionWrapper
+      include Util::Model
+      include ActionHandler
+
+      # Creates an instance of ActionWrapper
+      def initialize
+        @watch = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the watch
+        # @return An instance of Array
+
+      def watch
+        @watch
+      end
+
+        # The method to set the value to watch
+        # @param watch [Array] An instance of Array
+
+      def watch=(watch)
+        if watch!=nil and !watch.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: watch EXPECTED TYPE: Array', nil, nil)
+        end
+        @watch = watch
+        @key_modified['watch'] = 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/notification/api_exception.rb

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