ZOHOCRMSDK2_0_docgo 6.2.0

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

@@ -0,0 +1,57 @@
+# This class represents the HTTP header name and value.
+require_relative 'util/data_type_converter'
+require_relative 'exception/sdk_exception'
+require_relative 'util/header_param_validator'
+
+module ZOHOCRMSDK
+  class HeaderMap
+    attr_accessor :header_hash
+
+    def initialize
+      @header_hash = {}
+    end
+
+    # This method is to add header name and value.
+    # @param header [Header] A Header class instance.
+    # @param value [Object] An object containing the header value.
+    def add(header, value)
+      unless header.is_a? Header
+        raise SDKException.new(Constants::HEADER_NULL_ERROR, Constants::HEADER_INSTANCE_NULL_ERROR)
+      end
+
+      header_name = header.name
+
+      if header_name.nil?
+        raise SDKException.new(Constants::HEADER_NAME_NULL_ERROR, Constants::HEADER_NAME_NULL_ERROR_MESSAGE)
+      end
+
+      if value.nil?
+        raise SDKException.new(Constants::HEADER_NULL_ERROR, header_name + Constants::NULL_VALUE_ERROR_MESSAGE)
+      end
+
+      header_value = nil
+
+      if header.class_name.nil?
+        begin
+          header_value = value.to_s
+        rescue StandardError
+          header_value = value
+        end
+      else
+        header_param_validator = Util::HeaderParamValidator.new
+        header_value = header_param_validator.validate(header, value)
+      end
+
+      header_value = header_value.to_s
+      if (@header_hash.key? header_name) && !@header_hash[header_name].nil?
+        existing_header_value = @header_hash[header_name]
+
+        existing_header_value = existing_header_value + ',' + header_value
+
+        @header_hash[header_name] = existing_header_value
+      else
+        @header_hash[header_name] = header_value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,255 @@
+=begin
+Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED 
+All rights reserved. 
+ 
+   Licensed under the Apache License, Version 2.0 (the "License"); 
+   you may not use this file except in compliance with the License. 
+   You may obtain a copy of the License at 
+ 
+       http://www.apache.org/licenses/LICENSE-2.0 
+ 
+   Unless required by applicable law or agreed to in writing, software 
+   distributed under the License is distributed on an "AS IS" BASIS, 
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
+   See the License for the specific language governing permissions and 
+   limitations under the License.
+=end
+
+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, :api_version
+    @@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, api_version: 2)
+      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
+
+      # Unless otherwise passed in, logging will be to filesystem using the WEBrick::BasicLog logger
+      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
+
+      @@initializer.api_version = api_version
+
+      @@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
+
+      initializer.api_version = @@initializer.api_version
+
+      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/layouts/api_exception.rb

@@ -0,0 +1,123 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Layouts
+    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
+end

data/src/com/zoho/crm/api/layouts/layout.rb

@@ -0,0 +1,274 @@
+require_relative '../profiles/profile'
+require_relative '../users/user'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Layouts
+    class Layout
+      include Util::Model
+
+      # Creates an instance of Layout
+      def initialize
+        @created_time = nil
+        @convert_mapping = nil
+        @modified_time = nil
+        @visible = nil
+        @created_for = nil
+        @name = nil
+        @modified_by = nil
+        @profiles = nil
+        @id = nil
+        @created_by = nil
+        @sections = nil
+        @status = nil
+        @key_modified = Hash.new
+      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 convert_mapping
+        # @return An instance of Hash
+
+      def convert_mapping
+        @convert_mapping
+      end
+
+        # The method to set the value to convert_mapping
+        # @param convert_mapping [Hash] An instance of Hash
+
+      def convert_mapping=(convert_mapping)
+        if convert_mapping!=nil and !convert_mapping.is_a? Hash
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: Hash', nil, nil)
+        end
+        @convert_mapping = convert_mapping
+        @key_modified['convert_mapping'] = 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 visible
+        # @return A Boolean value
+
+      def visible
+        @visible
+      end
+
+        # The method to set the value to visible
+        # @param visible [Boolean] A Boolean
+
+      def visible=(visible)
+        if visible!=nil and ! [true, false].include?visible
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @visible = visible
+        @key_modified['visible'] = 1
+      end
+
+        # The method to get the created_for
+        # @return An instance of Users::User
+
+      def created_for
+        @created_for
+      end
+
+        # The method to set the value to created_for
+        # @param created_for [Users::User] An instance of Users::User
+
+      def created_for=(created_for)
+        if created_for!=nil and !created_for.is_a? Users::User
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_for EXPECTED TYPE: User', nil, nil)
+        end
+        @created_for = created_for
+        @key_modified['created_for'] = 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 profiles
+        # @return An instance of Array
+
+      def profiles
+        @profiles
+      end
+
+        # The method to set the value to profiles
+        # @param profiles [Array] An instance of Array
+
+      def profiles=(profiles)
+        if profiles!=nil and !profiles.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: Array', nil, nil)
+        end
+        @profiles = profiles
+        @key_modified['profiles'] = 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 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 sections
+        # @return An instance of Array
+
+      def sections
+        @sections
+      end
+
+        # The method to set the value to sections
+        # @param sections [Array] An instance of Array
+
+      def sections=(sections)
+        if sections!=nil and !sections.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sections EXPECTED TYPE: Array', nil, nil)
+        end
+        @sections = sections
+        @key_modified['sections'] = 1
+      end
+
+        # The method to get the status
+        # @return A Integer value
+
+      def status
+        @status
+      end
+
+        # The method to set the value to status
+        # @param status [Integer] A Integer
+
+      def status=(status)
+        if status!=nil and !status.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Integer', nil, nil)
+        end
+        @status = status
+        @key_modified['status'] = 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