ZCRMSDK 1.0.4 → 3.0.0

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

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

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

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

data/src/com/zoho/crm/api/exception/sdk_exception.rb

@@ -0,0 +1,47 @@
+# This class is the common SDKException object.
+class SDKException < StandardError
+  attr_reader :code, :message, :cause, :details, :back_trace
+
+  # Creates an SDKException class instance with the specified parameters.
+  # @param code A String containing the Exception error code.
+  # @param message A String containing the Exception error message.
+  # @param details A hash containing the error response.
+  # @param cause An Exception class instance.
+  def initialize(code, message, details = nil, cause = nil)
+    @code = code
+    @message = message
+    @cause = cause
+    @details = details
+
+    return if cause.nil?
+
+    set_backtrace(cause.backtrace)
+    @message = '' if @message.nil?
+    if cause.is_a? SDKException
+      @message += cause.to_s
+    else
+      cause_message = if cause.message.nil?
+                        cause.class.name
+                      else
+                        cause.class.name + ' : ' + cause.message
+                      end
+
+      @message = @message.nil? ? cause_message : @message + cause_message
+    end
+  end
+
+  def to_s
+    return_msg = ''
+
+    unless @details.nil?
+      @message = @message.nil? ? @details.to_s : (@message + @details.to_s)
+    end
+
+    return_msg += if @code.nil?
+                    @message
+                  else
+                    @code + '_' + @message
+                  end
+    return_msg
+  end
+end

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

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module FieldAttachments
+  require_relative 'response_handler'
+  class APIException
+    include Util::Model
+    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/field_attachments/body_wrapper.rb

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

@@ -0,0 +1,52 @@
+require_relative '../param'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module FieldAttachments
+  class FieldAttachmentsOperations
+
+      # Creates an instance of FieldAttachmentsOperations with the given parameters
+      # @param module_api_name [String] A String
+      # @param record_id [Integer] A Integer
+      # @param fields_attachment_id [Integer] A Integer
+    def initialize(module_api_name, record_id, fields_attachment_id=nil)
+      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 !record_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      if fields_attachment_id!=nil and !fields_attachment_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: fields_attachment_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      @module_api_name = module_api_name
+      @record_id = record_id
+      @fields_attachment_id = fields_attachment_id
+    end
+
+      # The method to get field attachments
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_field_attachments
+      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/download_fields_attachment'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_GET
+      handler_instance.category_method = 'READ'
+      handler_instance.add_param(Param.new('fields_attachment_id', 'com.zoho.crm.api.FieldAttachments.GetFieldAttachmentsParam'), @fields_attachment_id)
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/x-download')
+    end
+
+    class GetFieldAttachmentsParam
+    end
+
+  end
+end

data/src/com/zoho/crm/api/field_attachments/file_body_wrapper.rb

@@ -0,0 +1,64 @@
+require_relative '../util/stream_wrapper'
+require_relative '../util/model'
+
+module FieldAttachments
+  require_relative 'response_handler'
+  class FileBodyWrapper
+    include Util::Model
+    include ResponseHandler
+
+    # Creates an instance of FileBodyWrapper
+    def initialize
+      @file = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the file
+      # @return An instance of Util::StreamWrapper
+
+    def file
+      @file
+    end
+
+      # The method to set the value to file
+      # @param file [Util::StreamWrapper] An instance of Util::StreamWrapper
+
+    def file=(file)
+      if file!=nil and !file.is_a? Util::StreamWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: file EXPECTED TYPE: Util::StreamWrapper', nil, nil)
+      end
+      @file = file
+      @key_modified['file'] = 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