ZCRMSDK 1.0.1 → 2.0.0

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

@@ -0,0 +1,16 @@
+require_relative 'util/constants'
+
+class RequestProxy
+  attr_accessor :host, :port, :user_name, :password
+  def initialize(host, port, user_name = nil, password = nil)
+    raise SDKException.new(Constants::REQUEST_PROXY_ERROR, Constants::HOST_ERROR_MESSAGE) if host.nil?
+
+    raise SDKException.new(Constants::REQUEST_PROXY_ERROR, Constants::PORT_ERROR_MESSAGE) if port.nil?
+
+    @host = host
+    @port = port
+    @user_name = user_name
+    @password = password
+    @password = '' if password.nil?
+  end
+end

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

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

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

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

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

@@ -0,0 +1,195 @@
+require_relative '../users/user'
+require_relative '../util/model'
+
+module Roles
+  class Role
+    include Util::Model
+
+    # Creates an instance of Role
+    def initialize
+      @display_label = nil
+      @forecast_manager = nil
+      @share_with_peers = nil
+      @name = nil
+      @description = nil
+      @id = nil
+      @reporting_to = nil
+      @admin_user = 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 forecast_manager
+      # @return An instance of Users::User
+
+    def forecast_manager
+      @forecast_manager
+    end
+
+      # The method to set the value to forecast_manager
+      # @param forecast_manager [Users::User] An instance of Users::User
+
+    def forecast_manager=(forecast_manager)
+      if forecast_manager!=nil and !forecast_manager.is_a? Users::User
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: forecast_manager EXPECTED TYPE: User', nil, nil)
+      end
+      @forecast_manager = forecast_manager
+      @key_modified['forecast_manager'] = 1
+    end
+
+      # The method to get the share_with_peers
+      # @return A Boolean value
+
+    def share_with_peers
+      @share_with_peers
+    end
+
+      # The method to set the value to share_with_peers
+      # @param share_with_peers [Boolean] A Boolean
+
+    def share_with_peers=(share_with_peers)
+      if share_with_peers!=nil and ! [true, false].include?share_with_peers
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: share_with_peers EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @share_with_peers = share_with_peers
+      @key_modified['share_with_peers'] = 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 get the description
+      # @return A String value
+
+    def description
+      @description
+    end
+
+      # The method to set the value to description
+      # @param description [String] A String
+
+    def description=(description)
+      if description!=nil and !description.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: description EXPECTED TYPE: String', nil, nil)
+      end
+      @description = description
+      @key_modified['description'] = 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 reporting_to
+      # @return An instance of Users::User
+
+    def reporting_to
+      @reporting_to
+    end
+
+      # The method to set the value to reporting_to
+      # @param reporting_to [Users::User] An instance of Users::User
+
+    def reporting_to=(reporting_to)
+      if reporting_to!=nil and !reporting_to.is_a? Users::User
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: reporting_to EXPECTED TYPE: User', nil, nil)
+      end
+      @reporting_to = reporting_to
+      @key_modified['reporting_to'] = 1
+    end
+
+      # The method to get the admin_user
+      # @return A Boolean value
+
+    def admin_user
+      @admin_user
+    end
+
+      # The method to set the value to admin_user
+      # @param admin_user [Boolean] A Boolean
+
+    def admin_user=(admin_user)
+      if admin_user!=nil and ! [true, false].include?admin_user
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: admin_user EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @admin_user = admin_user
+      @key_modified['admin_user'] = 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/roles/roles_operations.rb

@@ -0,0 +1,47 @@
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module Roles
+  class RolesOperations
+
+    # Creates an instance of RolesOperations
+    def initialize
+    end
+
+      # The method to get roles
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_roles
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/settings/roles'
+      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 get role
+      # @param id [Integer] A Integer
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_role(id)
+      if !id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/settings/roles/'
+      api_path = api_path + id.to_s
+      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
+
+  end
+end