ZOHOCRMSDK2_1 1.0.0

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

@@ -0,0 +1,49 @@
+module ZOHOCRMSDK
+  # 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
+end

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

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

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

@@ -0,0 +1,64 @@
+require_relative '../util/stream_wrapper'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  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
+end

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

@@ -0,0 +1,54 @@
+require_relative '../param'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module ZOHOCRMSDK
+  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
+end

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

@@ -0,0 +1,66 @@
+require_relative '../util/stream_wrapper'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  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
+end

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

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

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

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

data/src/com/zoho/crm/api/fields/association_details.rb

@@ -0,0 +1,82 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Fields
+    class AssociationDetails
+      include Util::Model
+
+      # Creates an instance of AssociationDetails
+      def initialize
+        @lookup_field = nil
+        @related_field = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the lookup_field
+        # @return An instance of LookupField
+
+      def lookup_field
+        @lookup_field
+      end
+
+        # The method to set the value to lookup_field
+        # @param lookup_field [LookupField] An instance of LookupField
+
+      def lookup_field=(lookup_field)
+        if lookup_field!=nil and !lookup_field.is_a? LookupField
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: lookup_field EXPECTED TYPE: LookupField', nil, nil)
+        end
+        @lookup_field = lookup_field
+        @key_modified['lookup_field'] = 1
+      end
+
+        # The method to get the related_field
+        # @return An instance of LookupField
+
+      def related_field
+        @related_field
+      end
+
+        # The method to set the value to related_field
+        # @param related_field [LookupField] An instance of LookupField
+
+      def related_field=(related_field)
+        if related_field!=nil and !related_field.is_a? LookupField
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: related_field EXPECTED TYPE: LookupField', nil, nil)
+        end
+        @related_field = related_field
+        @key_modified['related_field'] = 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/fields/auto_number.rb

@@ -0,0 +1,101 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Fields
+    class AutoNumber
+      include Util::Model
+
+      # Creates an instance of AutoNumber
+      def initialize
+        @prefix = nil
+        @suffix = nil
+        @start_number = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the prefix
+        # @return A String value
+
+      def prefix
+        @prefix
+      end
+
+        # The method to set the value to prefix
+        # @param prefix [String] A String
+
+      def prefix=(prefix)
+        if prefix!=nil and !prefix.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: prefix EXPECTED TYPE: String', nil, nil)
+        end
+        @prefix = prefix
+        @key_modified['prefix'] = 1
+      end
+
+        # The method to get the suffix
+        # @return A String value
+
+      def suffix
+        @suffix
+      end
+
+        # The method to set the value to suffix
+        # @param suffix [String] A String
+
+      def suffix=(suffix)
+        if suffix!=nil and !suffix.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: suffix EXPECTED TYPE: String', nil, nil)
+        end
+        @suffix = suffix
+        @key_modified['suffix'] = 1
+      end
+
+        # The method to get the start_number
+        # @return A Integer value
+
+      def start_number
+        @start_number
+      end
+
+        # The method to set the value to start_number
+        # @param start_number [Integer] A Integer
+
+      def start_number=(start_number)
+        if start_number!=nil and !start_number.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: start_number EXPECTED TYPE: Integer', nil, nil)
+        end
+        @start_number = start_number
+        @key_modified['start_number'] = 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