ZOHOCRMSDK2_0_docgo 6.2.0

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

@@ -0,0 +1,151 @@
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module ZOHOCRMSDK
+  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 = "/crm/v#{Initializer.get_initializer.api_version}/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 = "/crm/v#{Initializer.get_initializer.api_version}/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 = "/crm/v#{Initializer.get_initializer.api_version}/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 = "/crm/v#{Initializer.get_initializer.api_version}/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 = "/crm/v#{Initializer.get_initializer.api_version}/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 = "/crm/v#{Initializer.get_initializer.api_version}/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 = "/crm/v#{Initializer.get_initializer.api_version}/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
+end

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

@@ -0,0 +1,292 @@
+require_relative '../users/user'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Currencies
+    class Currency
+      include Util::Model
+
+      # Creates an instance of Currency
+      def initialize
+        @symbol = nil
+        @created_time = nil
+        @is_active = nil
+        @exchange_rate = nil
+        @format = nil
+        @created_by = nil
+        @prefix_symbol = nil
+        @is_base = nil
+        @modified_time = nil
+        @name = nil
+        @modified_by = nil
+        @id = nil
+        @iso_code = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the symbol
+        # @return A String value
+
+      def symbol
+        @symbol
+      end
+
+        # The method to set the value to symbol
+        # @param symbol [String] A String
+
+      def symbol=(symbol)
+        if symbol!=nil and !symbol.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: symbol EXPECTED TYPE: String', nil, nil)
+        end
+        @symbol = symbol
+        @key_modified['symbol'] = 1
+      end
+
+        # The method to get the created_time
+        # @return An instance of DateTime
+
+      def created_time
+        @created_time
+      end
+
+        # The method to set the value to created_time
+        # @param created_time [DateTime] An instance of DateTime
+
+      def created_time=(created_time)
+        if created_time!=nil and !created_time.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: DateTime', nil, nil)
+        end
+        @created_time = created_time
+        @key_modified['created_time'] = 1
+      end
+
+        # The method to get the is_active
+        # @return A Boolean value
+
+      def is_active
+        @is_active
+      end
+
+        # The method to set the value to is_active
+        # @param is_active [Boolean] A Boolean
+
+      def is_active=(is_active)
+        if is_active!=nil and ! [true, false].include?is_active
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: is_active EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @is_active = is_active
+        @key_modified['is_active'] = 1
+      end
+
+        # The method to get the exchange_rate
+        # @return A String value
+
+      def exchange_rate
+        @exchange_rate
+      end
+
+        # The method to set the value to exchange_rate
+        # @param exchange_rate [String] A String
+
+      def exchange_rate=(exchange_rate)
+        if exchange_rate!=nil and !exchange_rate.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: exchange_rate EXPECTED TYPE: String', nil, nil)
+        end
+        @exchange_rate = exchange_rate
+        @key_modified['exchange_rate'] = 1
+      end
+
+        # The method to get the format
+        # @return An instance of Format
+
+      def format
+        @format
+      end
+
+        # The method to set the value to format
+        # @param format [Format] An instance of Format
+
+      def format=(format)
+        if format!=nil and !format.is_a? Format
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: format EXPECTED TYPE: Format', nil, nil)
+        end
+        @format = format
+        @key_modified['format'] = 1
+      end
+
+        # The method to get the created_by
+        # @return An instance of Users::User
+
+      def created_by
+        @created_by
+      end
+
+        # The method to set the value to created_by
+        # @param created_by [Users::User] An instance of Users::User
+
+      def created_by=(created_by)
+        if created_by!=nil and !created_by.is_a? Users::User
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', nil, nil)
+        end
+        @created_by = created_by
+        @key_modified['created_by'] = 1
+      end
+
+        # The method to get the prefix_symbol
+        # @return A Boolean value
+
+      def prefix_symbol
+        @prefix_symbol
+      end
+
+        # The method to set the value to prefix_symbol
+        # @param prefix_symbol [Boolean] A Boolean
+
+      def prefix_symbol=(prefix_symbol)
+        if prefix_symbol!=nil and ! [true, false].include?prefix_symbol
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: prefix_symbol EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @prefix_symbol = prefix_symbol
+        @key_modified['prefix_symbol'] = 1
+      end
+
+        # The method to get the is_base
+        # @return A Boolean value
+
+      def is_base
+        @is_base
+      end
+
+        # The method to set the value to is_base
+        # @param is_base [Boolean] A Boolean
+
+      def is_base=(is_base)
+        if is_base!=nil and ! [true, false].include?is_base
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: is_base EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @is_base = is_base
+        @key_modified['is_base'] = 1
+      end
+
+        # The method to get the modified_time
+        # @return An instance of DateTime
+
+      def modified_time
+        @modified_time
+      end
+
+        # The method to set the value to modified_time
+        # @param modified_time [DateTime] An instance of DateTime
+
+      def modified_time=(modified_time)
+        if modified_time!=nil and !modified_time.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: DateTime', nil, nil)
+        end
+        @modified_time = modified_time
+        @key_modified['modified_time'] = 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 modified_by
+        # @return An instance of Users::User
+
+      def modified_by
+        @modified_by
+      end
+
+        # The method to set the value to modified_by
+        # @param modified_by [Users::User] An instance of Users::User
+
+      def modified_by=(modified_by)
+        if modified_by!=nil and !modified_by.is_a? Users::User
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', nil, nil)
+        end
+        @modified_by = modified_by
+        @key_modified['modified_by'] = 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 iso_code
+        # @return A String value
+
+      def iso_code
+        @iso_code
+      end
+
+        # The method to set the value to iso_code
+        # @param iso_code [String] A String
+
+      def iso_code=(iso_code)
+        if iso_code!=nil and !iso_code.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: iso_code EXPECTED TYPE: String', nil, nil)
+        end
+        @iso_code = iso_code
+        @key_modified['iso_code'] = 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/currencies/format.rb

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

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

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

@@ -0,0 +1,65 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Currencies
+    require_relative 'response_handler'
+    class ResponseWrapper
+      include Util::Model
+      include ResponseHandler
+
+      # Creates an instance of ResponseWrapper
+      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
+end