ZCRMSDK 1.0.4 → 3.0.0

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

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

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

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

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

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

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

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

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

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