ZCRMSDK 1.0.1 → 2.0.0

data/src/com/zoho/crm/api/org/org_operations.rb

@@ -0,0 +1,49 @@
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module Org
+  class OrgOperations
+
+    # Creates an instance of OrgOperations
+    def initialize
+    end
+
+      # The method to get organization
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_organization
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/org'
+      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 upload organization photo
+      # @param request [FileBodyWrapper] An instance of FileBodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def upload_organization_photo(request)
+      if request!=nil and !request.is_a? FileBodyWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/org/photo'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_POST
+      handler_instance.category_method = 'CREATE'
+      handler_instance.content_type = 'multipart/form-data'
+      handler_instance.request = request
+      handler_instance.mandatory_checker = true
+      require_relative 'action_response'
+      handler_instance.api_call(ActionResponse.name, 'application/json')
+    end
+
+  end
+end

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

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

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

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

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Org
+  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/param.rb

@@ -0,0 +1,10 @@
+# This class represents the HTTP header name
+class Param
+  attr_accessor :name, :class_name
+  # Creates a Param class instance with the specified header name.
+  # @param name [String] A String containing the param name.
+  def initialize(name, class_name = nil)
+    @name = name
+    @class_name = class_name
+  end
+end

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

@@ -0,0 +1,54 @@
+require_relative 'util/data_type_converter'
+require_relative 'exception/sdk_exception'
+require_relative 'util/header_param_validator'
+
+class ParameterMap
+  attr_accessor :param_hash
+
+  def initialize
+    @param_hash = {}
+  end
+
+  # This method is to add parameter name and value.
+  # @param param [Param] A Param class instance.
+  # @param value [Object] An object containing the parameter value.
+  def add(param, value)
+    unless param.is_a? Param
+      raise SDKException.new(Constants::PARAMETER_NULL_ERROR, Constants::PARAM_INSTANCE_NULL_ERROR)
+    end
+
+    param_name = param.name
+
+    if param_name.nil?
+      raise SDKException.new(Constants::PARAM_NAME_NULL_ERROR, Constants::PARAM_NAME_NULL_ERROR_MESSAGE)
+    end
+
+    if value.nil?
+      raise SDKException.new(Constants::PARAMETER_NULL_ERROR, header_name + Constants::NULL_VALUE_ERROR_MESSAGE)
+    end
+
+    param_value = nil
+
+    if param.class_name.nil?
+      begin
+        param_value = value.to_s
+      rescue StandardError
+        param_value = value
+      end
+    else
+      header_param_validator = Util::HeaderParamValidator.new
+      param_value = header_param_validator.validate(param, value)
+    end
+
+    param_value = param_value.to_s
+    if (@param_hash.key? param_name) && !@param_hash[param_name].nil?
+      existing_param_value = @param_hash[param_name]
+
+      existing_param_value = existing_param_value + ',' + param_value
+
+      @param_hash[param_name] = existing_param_value
+    else
+      @param_hash[param_name] = param_value
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Profiles
+  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/profiles/category.rb

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