ZOHOCRMSDK2_0_docgo 6.2.0

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

@@ -0,0 +1,63 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Notification
+    class BodyWrapper
+      include Util::Model
+
+      # Creates an instance of BodyWrapper
+      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/info.rb

@@ -0,0 +1,120 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Notification
+    class Info
+      include Util::Model
+
+      # Creates an instance of Info
+      def initialize
+        @per_page = nil
+        @count = nil
+        @page = nil
+        @more_records = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the per_page
+        # @return A Integer value
+
+      def per_page
+        @per_page
+      end
+
+        # The method to set the value to per_page
+        # @param per_page [Integer] A Integer
+
+      def per_page=(per_page)
+        if per_page!=nil and !per_page.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: Integer', nil, nil)
+        end
+        @per_page = per_page
+        @key_modified['per_page'] = 1
+      end
+
+        # The method to get the count
+        # @return A Integer value
+
+      def count
+        @count
+      end
+
+        # The method to set the value to count
+        # @param count [Integer] A Integer
+
+      def count=(count)
+        if count!=nil and !count.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: Integer', nil, nil)
+        end
+        @count = count
+        @key_modified['count'] = 1
+      end
+
+        # The method to get the page
+        # @return A Integer value
+
+      def page
+        @page
+      end
+
+        # The method to set the value to page
+        # @param page [Integer] A Integer
+
+      def page=(page)
+        if page!=nil and !page.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: Integer', nil, nil)
+        end
+        @page = page
+        @key_modified['page'] = 1
+      end
+
+        # The method to get the more_records
+        # @return A Boolean value
+
+      def more_records
+        @more_records
+      end
+
+        # The method to set the value to more_records
+        # @param more_records [Boolean] A Boolean
+
+      def more_records=(more_records)
+        if more_records!=nil and ! [true, false].include?more_records
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: more_records EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @more_records = more_records
+        @key_modified['more_records'] = 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/notification.rb

@@ -0,0 +1,253 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Notification
+    class Notification
+      include Util::Model
+
+      # Creates an instance of Notification
+      def initialize
+        @channel_expiry = nil
+        @resource_uri = nil
+        @resource_id = nil
+        @notify_url = nil
+        @resource_name = nil
+        @channel_id = nil
+        @events = nil
+        @token = nil
+        @notify_on_related_action = nil
+        @fields = nil
+        @deleteevents = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the channel_expiry
+        # @return An instance of DateTime
+
+      def channel_expiry
+        @channel_expiry
+      end
+
+        # The method to set the value to channel_expiry
+        # @param channel_expiry [DateTime] An instance of DateTime
+
+      def channel_expiry=(channel_expiry)
+        if channel_expiry!=nil and !channel_expiry.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: channel_expiry EXPECTED TYPE: DateTime', nil, nil)
+        end
+        @channel_expiry = channel_expiry
+        @key_modified['channel_expiry'] = 1
+      end
+
+        # The method to get the resource_uri
+        # @return A String value
+
+      def resource_uri
+        @resource_uri
+      end
+
+        # The method to set the value to resource_uri
+        # @param resource_uri [String] A String
+
+      def resource_uri=(resource_uri)
+        if resource_uri!=nil and !resource_uri.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: resource_uri EXPECTED TYPE: String', nil, nil)
+        end
+        @resource_uri = resource_uri
+        @key_modified['resource_uri'] = 1
+      end
+
+        # The method to get the resource_id
+        # @return A String value
+
+      def resource_id
+        @resource_id
+      end
+
+        # The method to set the value to resource_id
+        # @param resource_id [String] A String
+
+      def resource_id=(resource_id)
+        if resource_id!=nil and !resource_id.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: resource_id EXPECTED TYPE: String', nil, nil)
+        end
+        @resource_id = resource_id
+        @key_modified['resource_id'] = 1
+      end
+
+        # The method to get the notify_url
+        # @return A String value
+
+      def notify_url
+        @notify_url
+      end
+
+        # The method to set the value to notify_url
+        # @param notify_url [String] A String
+
+      def notify_url=(notify_url)
+        if notify_url!=nil and !notify_url.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: notify_url EXPECTED TYPE: String', nil, nil)
+        end
+        @notify_url = notify_url
+        @key_modified['notify_url'] = 1
+      end
+
+        # The method to get the resource_name
+        # @return A String value
+
+      def resource_name
+        @resource_name
+      end
+
+        # The method to set the value to resource_name
+        # @param resource_name [String] A String
+
+      def resource_name=(resource_name)
+        if resource_name!=nil and !resource_name.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: resource_name EXPECTED TYPE: String', nil, nil)
+        end
+        @resource_name = resource_name
+        @key_modified['resource_name'] = 1
+      end
+
+        # The method to get the channel_id
+        # @return A Integer value
+
+      def channel_id
+        @channel_id
+      end
+
+        # The method to set the value to channel_id
+        # @param channel_id [Integer] A Integer
+
+      def channel_id=(channel_id)
+        if channel_id!=nil and !channel_id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: channel_id EXPECTED TYPE: Integer', nil, nil)
+        end
+        @channel_id = channel_id
+        @key_modified['channel_id'] = 1
+      end
+
+        # The method to get the events
+        # @return An instance of Array
+
+      def events
+        @events
+      end
+
+        # The method to set the value to events
+        # @param events [Array] An instance of Array
+
+      def events=(events)
+        if events!=nil and !events.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: events EXPECTED TYPE: Array', nil, nil)
+        end
+        @events = events
+        @key_modified['events'] = 1
+      end
+
+        # The method to get the token
+        # @return A String value
+
+      def token
+        @token
+      end
+
+        # The method to set the value to token
+        # @param token [String] A String
+
+      def token=(token)
+        if token!=nil and !token.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: token EXPECTED TYPE: String', nil, nil)
+        end
+        @token = token
+        @key_modified['token'] = 1
+      end
+
+        # The method to get the notify_on_related_action
+        # @return A Boolean value
+
+      def notify_on_related_action
+        @notify_on_related_action
+      end
+
+        # The method to set the value to notify_on_related_action
+        # @param notify_on_related_action [Boolean] A Boolean
+
+      def notify_on_related_action=(notify_on_related_action)
+        if notify_on_related_action!=nil and ! [true, false].include?notify_on_related_action
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: notify_on_related_action EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @notify_on_related_action = notify_on_related_action
+        @key_modified['notify_on_related_action'] = 1
+      end
+
+        # The method to get the fields
+        # @return An instance of Hash
+
+      def fields
+        @fields
+      end
+
+        # The method to set the value to fields
+        # @param fields [Hash] An instance of Hash
+
+      def fields=(fields)
+        if fields!=nil and !fields.is_a? Hash
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: Hash', nil, nil)
+        end
+        @fields = fields
+        @key_modified['fields'] = 1
+      end
+
+        # The method to get the deleteevents
+        # @return A Boolean value
+
+      def deleteevents
+        @deleteevents
+      end
+
+        # The method to set the value to deleteevents
+        # @param deleteevents [Boolean] A Boolean
+
+      def deleteevents=(deleteevents)
+        if deleteevents!=nil and ! [true, false].include?deleteevents
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: deleteevents EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @deleteevents = deleteevents
+        @key_modified['_delete_events'] = 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/notification_operations.rb

@@ -0,0 +1,160 @@
+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 Notification
+    class NotificationOperations
+
+      # Creates an instance of NotificationOperations
+      def initialize
+      end
+
+        # The method to enable notifications
+        # @param request [BodyWrapper] An instance of BodyWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def enable_notifications(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}/actions/watch"
+        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 notification details
+        # @param param_instance [ParameterMap] An instance of ParameterMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_notification_details(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}/actions/watch"
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_GET
+        handler_instance.category_method = 'READ'
+        handler_instance.param = param_instance
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
+      end
+
+        # The method to update notifications
+        # @param request [BodyWrapper] An instance of BodyWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def update_notifications(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}/actions/watch"
+        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 update notification
+        # @param request [BodyWrapper] An instance of BodyWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def update_notification(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}/actions/watch"
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_PATCH
+        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 disable notifications
+        # @param param_instance [ParameterMap] An instance of ParameterMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def disable_notifications(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}/actions/watch"
+        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 disable notification
+        # @param request [BodyWrapper] An instance of BodyWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def disable_notification(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}/actions/watch"
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_PATCH
+        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
+
+      class GetNotificationDetailsParam
+          @@page =   Param.new('page', 'com.zoho.crm.api.Notification.GetNotificationDetailsParam')
+        def self.page
+          @@page
+        end
+          @@per_page =   Param.new('per_page', 'com.zoho.crm.api.Notification.GetNotificationDetailsParam')
+        def self.per_page
+          @@per_page
+        end
+          @@channel_id =   Param.new('channel_id', 'com.zoho.crm.api.Notification.GetNotificationDetailsParam')
+        def self.channel_id
+          @@channel_id
+        end
+          @@module_1 =   Param.new('module', 'com.zoho.crm.api.Notification.GetNotificationDetailsParam')
+        def self.module_1
+          @@module_1
+        end
+      end
+
+      class DisableNotificationsParam
+          @@channel_ids =   Param.new('channel_ids', 'com.zoho.crm.api.Notification.DisableNotificationsParam')
+        def self.channel_ids
+          @@channel_ids
+        end
+      end
+
+    end
+  end
+end

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

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

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

@@ -0,0 +1,84 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Notification
+    require_relative 'response_handler'
+    class ResponseWrapper
+      include Util::Model
+      include ResponseHandler
+
+      # Creates an instance of ResponseWrapper
+      def initialize
+        @watch = nil
+        @info = 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 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