ZOHOCRMSDK2_1 1.0.0

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

@@ -0,0 +1,232 @@
+require 'uri'
+require 'net/http'
+require 'cgi'
+require 'json'
+require_relative '../../api/logger/sdk_logger'
+require_relative 'util/constants'
+
+module ZOHOCRMSDK
+  # This class to initialize Zoho CRM SDK.
+  class Initializer
+    attr_accessor :json_details,:user, :environment, :store, :token, :initializer, :local, :sdk_config, :resources_path, :request_proxy
+    @@json_details = nil
+
+    Thread.current['initi'] = nil
+
+    def self.json_details
+      @@json_details
+    end
+
+    def self.initialize(user:, environment:, token:, store: nil, sdk_config: nil, resources_path: nil, log: nil, request_proxy: nil)
+      error = {}
+
+      require_relative 'user_signature'
+
+      unless user.is_a?(UserSignature)
+        error[Constants::ERROR_HASH_FIELD] = 'user'
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = UserSignature
+
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::USER_SIGNATURE_ERROR_MESSAGE, error, nil)
+
+      end
+
+      require_relative '../../crm/api/dc/datacenter'
+
+      unless environment.is_a? (DC::DataCenter::Environment)
+        error[Constants::ERROR_HASH_FIELD] = 'environment'
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = DC::DataCenter::Environment
+
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::ENVIRONMENT_ERROR_MESSAGE, error, nil)
+
+      end
+
+      require_relative '../../api/authenticator/token'
+
+      unless token.is_a?(Authenticator::Token)
+        error[Constants::ERROR_HASH_FIELD] = 'token'
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = Authenticator::Token
+
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::TOKEN_ERROR_MESSAGE, error, nil)
+
+      end
+
+      require_relative '../../api/authenticator/store/token_store'
+
+      if !store.nil? && !store.is_a?(Store::TokenStore)
+        error[Constants::ERROR_HASH_FIELD] = 'store'
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = Store::TokenStore
+
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::STORE_ERROR_MESSAGE, error, nil)
+
+      end
+
+      require_relative 'sdk_config'
+
+      if !sdk_config.nil? && !sdk_config.is_a?(SDKConfig)
+        error[Constants::ERROR_HASH_FIELD] = 'sdk_config'
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = SDKConfig
+
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::SDK_CONFIG_ERROR_MESSAGE, error, nil)
+
+      end
+
+      if !request_proxy.nil? && !request_proxy.is_a?(RequestProxy)
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::REQUEST_PROXY_ERROR, nil, nil)
+      end
+
+      if store.nil?
+        require_relative '../../api/authenticator/store/file_store'
+
+        store = Store::FileStore.new(File.join(Dir.pwd, Constants::TOKEN_FILE))
+      
+      end
+      
+      if sdk_config.nil?
+        sdk_config = SDKConfig.new()
+      end
+      
+      if resources_path.nil?
+        resources_path = Dir.pwd
+      end
+
+      if !File.directory?(resources_path)
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::RESOURCE_PATH_INVALID_ERROR_MESSAGE, nil, nil)
+      end
+
+      log = SDKLog::Log.initialize(level: Levels::INFO, path: File.join(Dir.pwd, Constants::LOG_FILE_NAME)) if log.nil? 
+      SDKLog::SDKLogger.initialize(log)
+
+      @@initializer = Initializer.new
+
+      @@initializer.user = user
+
+      @@initializer.environment = environment
+
+      @@initializer.sdk_config = sdk_config
+
+      @@initializer.token = token
+
+      @@initializer.store = store
+
+      @@initializer.resources_path = resources_path
+
+      @@initializer.request_proxy = request_proxy
+
+      @@json_details = get_JSONDetails
+
+      SDKLog::SDKLogger.info(Constants::INITIALIZATION_SUCCESSFUL + @@initializer.to_s)
+    rescue SDKException => e
+      raise e
+    rescue StandardError => e
+      raise SDKException.new(nil, Constants::INITIALIZATION_ERROR, nil, e)
+    end
+
+    def self.get_JSONDetails
+      if @@json_details.nil? || @@json_details.length == 0
+        return JSON.parse(File.open(File.join(File.dirname(File.expand_path(__FILE__)), '../../../../' + Constants::JSON_DETAILS_FILE_PATH)).read)
+      end
+      @@json_details
+    rescue StandardError => e
+      raise SDKException.new(nil, Constants::EXCEPTION_JSONDETAILS, nil, e)
+    end
+
+    def self.get_initializer
+      return Thread.current['initi'] unless Thread.current['initi'].nil?
+
+      @@initializer
+    end
+
+    def self.switch_user(user:nil, environment:nil, token:nil, sdk_config:nil, request_proxy: nil)
+      
+      if @@initializer.nil?
+        raise SDKException.new(Constants::SDK_UNINITIALIZATION_ERROR, Constants::SDK_UNINITIALIZATION_MESSAGE)
+      end
+
+      require_relative 'user_signature'
+
+      if !user.nil? and !user.is_a?(UserSignature)
+        error[Constants::ERROR_HASH_FIELD] = 'user'
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = UserSignature
+
+        raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::USER_SIGNATURE_ERROR_MESSAGE, error, nil)
+
+      end
+
+      require_relative '../../crm/api/dc/datacenter'
+
+      if !environment.nil? and !environment.is_a?(DC::DataCenter::Environment)
+        error[Constants::ERROR_HASH_FIELD] = 'environment'
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = DC::DataCenter::Environment
+
+        raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::ENVIRONMENT_ERROR_MESSAGE, error, nil)
+
+      end
+
+      require_relative '../../api/authenticator/token'
+
+      if !token.nil? and !token.is_a?(Authenticator::Token)
+        error[Constants::ERROR_HASH_FIELD] = 'token'
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = Authenticator::Token
+
+        raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::TOKEN_ERROR_MESSAGE, error, nil)
+
+      end
+
+      require_relative 'request_proxy'
+
+      if !request_proxy.nil? and !request_proxy.is_a?(RequestProxy)
+        error[Constants::ERROR_HASH_FIELD] = 'request_proxy'
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = RequestProxy
+
+        raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::REQUEST_PROXY_ERROR_MESSAGE, error, nil)
+
+      end
+
+      require_relative 'sdk_config'
+
+      if !sdk_config.nil? and !sdk_config.is_a?(SDKConfig)
+        error[Constants::ERROR_HASH_FIELD] = 'sdk_config'
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = SDKConfig
+
+        raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::SDK_CONFIG_ERROR_MESSAGE, error, nil)
+
+      end
+
+      initializer = Initializer.new
+
+      previous_initializer = Initializer.get_initializer
+
+      initializer.user = user.nil? ? previous_initializer.user : user
+
+      initializer.environment = environment.nil? ? previous_initializer.environment : environment
+
+      initializer.sdk_config = sdk_config.nil? ? previous_initializer.sdk_config : sdk_config
+
+      initializer.token = token.nil? ? previous_initializer.token : token
+
+      initializer.store = @@initializer.store
+
+      initializer.resources_path = @@initializer.resources_path
+
+      initializer.request_proxy = request_proxy
+
+      Thread.current['initi'] = initializer
+
+      SDKLog::SDKLogger.info(Constants::INITIALIZATION_SWITCHED + initializer.to_s)
+    end
+
+    def to_s
+      Constants::FOR_EMAIL_ID + Initializer.get_initializer.user.email + Constants::IN_ENVIRONMENT + Initializer.get_initializer.environment.url + '.'
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module InventoryTemplates
+    require_relative 'response_handler'
+    class APIException
+      include Util::Model
+      include ResponseHandler
+
+      # Creates an instance of APIException
+      def initialize
+        @code = nil
+        @status = nil
+        @message = nil
+        @details = nil
+        @key_modified = Hash.new
+      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 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 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/inventory_templates/inventory_template.rb

@@ -0,0 +1,354 @@
+require_relative '../modules/module'
+require_relative '../send_mail/template'
+require_relative '../users/user'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module InventoryTemplates
+require_relative '../send_mail/template'
+
+    class InventoryTemplate
+      include SendMail::Template
+      include Util::Model
+
+      # Creates an instance of InventoryTemplate
+      def initialize
+        @content = nil
+        @created_time = nil
+        @subject = nil
+        @module_1 = nil
+        @type = nil
+        @created_by = nil
+        @modified_time = nil
+        @last_usage_time = nil
+        @associated = nil
+        @name = nil
+        @modified_by = nil
+        @description = nil
+        @id = nil
+        @editor_mode = nil
+        @favorite = nil
+        @folder = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the content
+        # @return A String value
+
+      def content
+        @content
+      end
+
+        # The method to set the value to content
+        # @param content [String] A String
+
+      def content=(content)
+        if content!=nil and !content.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: String', nil, nil)
+        end
+        @content = content
+        @key_modified['content'] = 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 subject
+        # @return A String value
+
+      def subject
+        @subject
+      end
+
+        # The method to set the value to subject
+        # @param subject [String] A String
+
+      def subject=(subject)
+        if subject!=nil and !subject.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: String', nil, nil)
+        end
+        @subject = subject
+        @key_modified['subject'] = 1
+      end
+
+        # The method to get the module
+        # @return An instance of Modules::Module
+
+      def module
+        @module_1
+      end
+
+        # The method to set the value to module
+        # @param module_1 [Modules::Module] An instance of Modules::Module
+
+      def module=(module_1)
+        if module_1!=nil and !module_1.is_a? Modules::Module
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: Module', nil, nil)
+        end
+        @module_1 = module_1
+        @key_modified['module'] = 1
+      end
+
+        # The method to get the type
+        # @return A String value
+
+      def type
+        @type
+      end
+
+        # The method to set the value to type
+        # @param type [String] A String
+
+      def type=(type)
+        if type!=nil and !type.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: String', nil, nil)
+        end
+        @type = type
+        @key_modified['type'] = 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 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 last_usage_time
+        # @return An instance of DateTime
+
+      def last_usage_time
+        @last_usage_time
+      end
+
+        # The method to set the value to last_usage_time
+        # @param last_usage_time [DateTime] An instance of DateTime
+
+      def last_usage_time=(last_usage_time)
+        if last_usage_time!=nil and !last_usage_time.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: last_usage_time EXPECTED TYPE: DateTime', nil, nil)
+        end
+        @last_usage_time = last_usage_time
+        @key_modified['last_usage_time'] = 1
+      end
+
+        # The method to get the associated
+        # @return A Boolean value
+
+      def associated
+        @associated
+      end
+
+        # The method to set the value to associated
+        # @param associated [Boolean] A Boolean
+
+      def associated=(associated)
+        if associated!=nil and ! [true, false].include?associated
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: associated EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @associated = associated
+        @key_modified['associated'] = 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 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 editor_mode
+        # @return A String value
+
+      def editor_mode
+        @editor_mode
+      end
+
+        # The method to set the value to editor_mode
+        # @param editor_mode [String] A String
+
+      def editor_mode=(editor_mode)
+        if editor_mode!=nil and !editor_mode.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: editor_mode EXPECTED TYPE: String', nil, nil)
+        end
+        @editor_mode = editor_mode
+        @key_modified['editor_mode'] = 1
+      end
+
+        # The method to get the favorite
+        # @return A Boolean value
+
+      def favorite
+        @favorite
+      end
+
+        # The method to set the value to favorite
+        # @param favorite [Boolean] A Boolean
+
+      def favorite=(favorite)
+        if favorite!=nil and ! [true, false].include?favorite
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: favorite EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @favorite = favorite
+        @key_modified['favorite'] = 1
+      end
+
+        # The method to get the folder
+        # @return An instance of InventoryTemplate
+
+      def folder
+        @folder
+      end
+
+        # The method to set the value to folder
+        # @param folder [InventoryTemplate] An instance of InventoryTemplate
+
+      def folder=(folder)
+        if folder!=nil and !folder.is_a? InventoryTemplate
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: folder EXPECTED TYPE: InventoryTemplate', nil, nil)
+        end
+        @folder = folder
+        @key_modified['folder'] = 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