ZCRMSDK 1.0.2 → 2.1.0

data/src/com/zoho/crm/api/currencies/action_handler.rb

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

data/src/com/zoho/crm/api/currencies/action_response.rb

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

data/src/com/zoho/crm/api/currencies/action_wrapper.rb

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

@@ -0,0 +1,127 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Currencies
+  require_relative 'response_handler'
+  require_relative 'action_response'
+  require_relative 'action_handler'
+  require_relative 'base_currency_action_handler'
+  class APIException
+    include Util::Model
+    include ResponseHandler
+    include ActionResponse
+    include ActionHandler
+    include BaseCurrencyActionHandler
+
+    # 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/currencies/base_currency_action_handler.rb

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

data/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.rb

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

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

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

@@ -0,0 +1,156 @@
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module Currencies
+  class CurrenciesOperations
+
+    # Creates an instance of CurrenciesOperations
+    def initialize
+    end
+
+      # The method to get currencies
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_currencies
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/org/currencies'
+      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 add currencies
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def add_currencies(request)
+      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/org/currencies'
+      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
+
+      # The method to update currencies
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def update_currencies(request)
+      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/org/currencies'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_PUT
+      handler_instance.category_method = 'UPDATE'
+      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
+
+      # The method to enable multiple currencies
+      # @param request [BaseCurrencyWrapper] An instance of BaseCurrencyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def enable_multiple_currencies(request)
+      if request!=nil and !request.is_a? BaseCurrencyWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BaseCurrencyWrapper', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/org/currencies/actions/enable'
+      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 'base_currency_action_handler'
+      handler_instance.api_call(BaseCurrencyActionHandler.name, 'application/json')
+    end
+
+      # The method to update base currency
+      # @param request [BaseCurrencyWrapper] An instance of BaseCurrencyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def update_base_currency(request)
+      if request!=nil and !request.is_a? BaseCurrencyWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BaseCurrencyWrapper', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/org/currencies/actions/enable'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_PUT
+      handler_instance.category_method = 'UPDATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      handler_instance.mandatory_checker = true
+      require_relative 'base_currency_action_handler'
+      handler_instance.api_call(BaseCurrencyActionHandler.name, 'application/json')
+    end
+
+      # The method to get currency
+      # @param id [Integer] A Integer
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_currency(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/org/currencies/'
+      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
+
+      # The method to update currency
+      # @param id [Integer] A Integer
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def update_currency(id, request)
+      if !id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', 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/org/currencies/'
+      api_path = api_path + id.to_s
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_PUT
+      handler_instance.category_method = 'UPDATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+  end
+end