ZCRMSDK 2.0.0 → 3.0.1

data/src/com/zoho/crm/api/send_mail/send_mail_operations.rb

@@ -0,0 +1,61 @@
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module SendMail
+  class SendMailOperations
+
+    # Creates an instance of SendMailOperations
+    def initialize
+    end
+
+      # The method to get email addresses
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_email_addresses
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2.1/settings/emails/actions/from_addresses'
+      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/json')
+    end
+
+      # The method to send mail
+      # @param record_id [Integer] A Integer
+      # @param module_api_name [String] A String
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def send_mail(record_id, module_api_name, request)
+      if !record_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      if !module_api_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', 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 = ''
+      api_path = api_path + '/crm/v2.1/'
+      api_path = api_path + module_api_name.to_s
+      api_path = api_path + '/'
+      api_path = api_path + record_id.to_s
+      api_path = api_path + '/actions/send_mail'
+      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
+
+  end
+end

data/src/com/zoho/crm/api/send_mail/success_response.rb

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module SendMail
+  require_relative 'action_response'
+  class SuccessResponse
+    include Util::Model
+    include ActionResponse
+
+    # Creates an instance of SuccessResponse
+    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/send_mail/template.rb

@@ -0,0 +1,10 @@
+module SendMail
+  module Template
+
+    # Creates an instance of Template
+    def initialize
+    end
+
+
+  end
+end

data/src/com/zoho/crm/api/send_mail/user_address.rb

@@ -0,0 +1,137 @@
+require_relative '../util/model'
+
+module SendMail
+  class UserAddress
+    include Util::Model
+
+    # Creates an instance of UserAddress
+    def initialize
+      @user_name = nil
+      @type = nil
+      @email = nil
+      @id = nil
+      @default = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the user_name
+      # @return A String value
+
+    def user_name
+      @user_name
+    end
+
+      # The method to set the value to user_name
+      # @param user_name [String] A String
+
+    def user_name=(user_name)
+      if user_name!=nil and !user_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: String', nil, nil)
+      end
+      @user_name = user_name
+      @key_modified['user_name'] = 1
+    end
+
+      # The method to get the type
+      # @return A String value
+
+    def type
+      @type
+    end
+
+      # The method to set the value to type
+      # @param type [String] A String
+
+    def type=(type)
+      if type!=nil and !type.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
+      end
+      @type = type
+      @key_modified['type'] = 1
+    end
+
+      # The method to get the email
+      # @return A String value
+
+    def email
+      @email
+    end
+
+      # The method to set the value to email
+      # @param email [String] A String
+
+    def email=(email)
+      if email!=nil and !email.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: String', nil, nil)
+      end
+      @email = email
+      @key_modified['email'] = 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 default
+      # @return A Boolean value
+
+    def default
+      @default
+    end
+
+      # The method to set the value to default
+      # @param default [Boolean] A Boolean
+
+    def default=(default)
+      if default!=nil and ! [true, false].include?default
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @default = default
+      @key_modified['default'] = 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/share_records/share_records_operations.rb

@@ -32,7 +32,7 @@ module ShareRecords
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + @module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + @record_id.to_s
@@ -55,7 +55,7 @@ module ShareRecords
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + @module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + @record_id.to_s
@@ -80,7 +80,7 @@ module ShareRecords
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + @module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + @record_id.to_s
@@ -101,7 +101,7 @@ module ShareRecords
     def revoke_shared_record
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + @module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + @record_id.to_s

data/src/com/zoho/crm/api/tags/tag.rb

@@ -11,6 +11,7 @@ module Tags
       @modified_time = nil
       @name = nil
       @modified_by = nil
+      @color_code = nil
       @id = nil
       @created_by = nil
       @key_modified = Hash.new
@@ -88,6 +89,24 @@ module Tags
       @key_modified['modified_by'] = 1
     end
 
+      # The method to get the color_code
+      # @return A String value
+
+    def color_code
+      @color_code
+    end
+
+      # The method to set the value to color_code
+      # @param color_code [String] A String
+
+    def color_code=(color_code)
+      if color_code!=nil and !color_code.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: color_code EXPECTED TYPE: String', nil, nil)
+      end
+      @color_code = color_code
+      @key_modified['color_code'] = 1
+    end
+
       # The method to get the id
       # @return A Integer value
 

data/src/com/zoho/crm/api/tags/tags_operations.rb

@@ -22,7 +22,7 @@ module Tags
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/settings/tags'
+      api_path = api_path + '/crm/v2.1/settings/tags'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET
       handler_instance.category_method = 'READ'
@@ -45,7 +45,7 @@ module Tags
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/settings/tags'
+      api_path = api_path + '/crm/v2.1/settings/tags'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_POST
       handler_instance.category_method = 'CREATE'
@@ -71,7 +71,7 @@ module Tags
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/settings/tags'
+      api_path = api_path + '/crm/v2.1/settings/tags'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_PUT
       handler_instance.category_method = 'UPDATE'
@@ -101,7 +101,7 @@ module Tags
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/settings/tags/'
+      api_path = api_path + '/crm/v2.1/settings/tags/'
       api_path = api_path + id.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_PUT
@@ -123,7 +123,7 @@ module Tags
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/settings/tags/'
+      api_path = api_path + '/crm/v2.1/settings/tags/'
       api_path = api_path + id.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
@@ -146,7 +146,7 @@ module Tags
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/settings/tags/'
+      api_path = api_path + '/crm/v2.1/settings/tags/'
       api_path = api_path + id.to_s
       api_path = api_path + '/actions/merge'
       handler_instance.api_path = api_path
@@ -177,7 +177,7 @@ module Tags
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + record_id.to_s
@@ -209,7 +209,7 @@ module Tags
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/'
       api_path = api_path + record_id.to_s
@@ -237,7 +237,7 @@ module Tags
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/actions/add_tags'
       handler_instance.api_path = api_path
@@ -263,7 +263,7 @@ module Tags
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/'
+      api_path = api_path + '/crm/v2.1/'
       api_path = api_path + module_api_name.to_s
       api_path = api_path + '/actions/remove_tags'
       handler_instance.api_path = api_path
@@ -289,7 +289,7 @@ module Tags
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/settings/tags/'
+      api_path = api_path + '/crm/v2.1/settings/tags/'
       api_path = api_path + id.to_s
       api_path = api_path + '/actions/records_count'
       handler_instance.api_path = api_path