ZOHOCRMSDK6_0 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df03134d69d2be679fa12f0fbb0ec43d979dad4616f031d5e0a63f83ad70e4eb
-  data.tar.gz: b5ec010e7e042d5ccf19c24992580dd18019aef19c9a9f7edc5cc96e86993aa4
+  metadata.gz: d2a6cea40a51128eb5eb3c8d898bc7017730874c6119a2890896df45901a633a
+  data.tar.gz: 341bd0e2717043d7d0e4a22b20e227a5b3a8b805e9ff26d4b35d876991c5fa34
 SHA512:
-  metadata.gz: 193b09c8097ea7b190d1a610d20444a8679cc5f892bfd42146c4f69089528a48df80a49b233d24dbc43f41b638d0cbe36f321e051bfd895c201d59f2a71c15ea
-  data.tar.gz: 134e51ad63761a05ef1fe1c1fde13bdac39ab14c92cbfffc8fb952226c752ff390cd8a2b8329bca7f15ec9f60e88ebeedb19dd3bd68cdcc6dd0759b5cef0da87
+  metadata.gz: 579fdf4bd68f15c0af345b9609bd968c01b7f6444c64c82c95fca1d115e25867f1d2fe8fba9d95da49b212362aac58deb2f5925685ec33ea97ee5c90ee796605
+  data.tar.gz: cd6718343a7a72fdcb8775c2e432ab33043863fd76ba06819255bd36c0cb1598d107e834b69e73c5e637044456a610ae120f0390c979252ac21de966125f51a6

data/src/ZOHOCRMSDK6_0.rb

@@ -1299,4 +1299,6 @@ require 'com/zoho/api/authenticator/oauth_token.rb'
 require 'com/zoho/api/authenticator/token.rb'
 require 'com/zoho/api/authenticator/store/db_store.rb'
 require 'com/zoho/api/authenticator/store/token_store.rb'
-require 'com/zoho/api/authenticator/store/file_store.rb'
+require 'com/zoho/api/authenticator/store/file_store.rb'
+require 'com/zoho/crm/api/users/count_handler.rb'
+require 'com/zoho/crm/api/users/count_wrapper.rb'

data/src/com/zoho/api/authenticator/store/db_store.rb

@@ -1,4 +1,3 @@
-require 'mysql2'
 require_relative 'token_store'
 require_relative '../oauth_token'
 require_relative '../../../crm/api/util/constants'
@@ -17,6 +16,7 @@ module ZOHOCRMSDK
       # @param password A String containing the DataBase password.
       # @param port_number A String containing the DataBase port number.
       def initialize(host: Constants::MYSQL_HOST, database_name: Constants::MYSQL_DATABASE_NAME , table_name: Constants::MYSQL_TABLE_NAME, user_name: Constants::MYSQL_USER_NAME, password: '', port_number: Constants::MYSQL_PORT_NUMBER )
+        require 'mysql2' unless Object.const_defined?(:Mysql2)
         @host = host
         @database_name = database_name
         @table_name = table_name

data/src/com/zoho/api/logger/sdk_logger.rb

@@ -1,5 +1,3 @@
-require 'webrick/log'
-require 'webrick/accesslog'
 require 'logger'
 
 module ZOHOCRMSDK
@@ -14,74 +12,52 @@ module ZOHOCRMSDK
       def self.initialize(level:, path:nil)
         Log.new(level, path)
       end
-    
-    end
 
-    class SilentLogger < WEBrick::BasicLog
-      def log(level, data) end # override log method for avoiding logs
+      def as_logger
+        return Logger.new(File.open(File::NULL, 'w')) if self.level == Levels::OFF || self.path.nil? || self.path == ""
+
+        logger = self.path.nil? ? Logger.new(STDOUT) : Logger.new(self.path)
+        logger.level = self.level ? Object.const_get("Logger::#{self.level}") : Logger::INFO
+        logger
+      end
     end
 
+    # Generic logger to support passing in a custom logger i.e. your application's Rails.logger
     class SDKLogger
-      @@path = nil
-      @@level = nil
-      @@log_levels_precedence = { 'FATAL' => 1, 'SEVERE' => 1, 'ERROR' => 2, 'WARN' => 3, 'INFO' => 4, 'ALL' => 5, 'DEBUG' => 5 , 'OFF' => 5}
-      @@logger = nil
-
       def self.initialize(log)
-
-        if (!log.level.nil? && (log.level == Levels::OFF || log.path.nil? || log.path == "") )
-          sdk_logger = SilentLogger.new.log(log.level, log.path)
-        else
-          if !log.level.nil? && log.level != Levels::OFF && !log.path.nil? && log.path.length > 0
-            if @@log_levels_precedence.key? log.level
-              File.new(log.path, 'w') unless File.exist? log.path if log.path != nil
-              sdk_logger = WEBrick::BasicLog.new(log.path, @@log_levels_precedence[log.level])
-            end
-          end
-
-          if !log.level.nil? && log.path.nil?
-            if  @@log_levels_precedence.key? log.level
-              sdk_logger = WEBrick::BasicLog.new(nil, @@log_levels_precedence[log.level])
-            end
-          end
-        end
-
-        @@logger = sdk_logger
+        return @logger = log.as_logger if log.is_a?(Log)
+        @logger = log
       rescue StandardError => e
         raise SDKException.new(nil, Constants::LOGGER_INITIALIZATION_ERROR, nil, e)
       end
 
       def self.info(message)
-        @@logger&.info(Time.new.to_s + ' ' + message)
+        @logger&.info("#{Time.new} #{message}")
       end
 
       def self.error(message, exception = nil)
-        unless exception.nil?
-          exception.to_s
-          message = message + exception.to_s + exception.backtrace.join("\n")
-        end
-        @@logger&.error(Time.new.to_s + ' ' + message)
+        message = "#{message}#{exception}#{exception.backtrace&.join("\n")}" unless exception.nil?
+        @logger&.error("#{Time.new} #{message}")
       end
 
       def self.warn(message)
-        @@logger&.warn(Time.new.to_s + ' ' + message)
+        @logger&.warn("#{Time.new} #{message}")
       end
 
       def self.severe(message, exception = nil)
-      
-        message = message + exception.to_s + exception.backtrace.join("\n") unless exception.nil? || exception.backtrace.nil?
-        @@logger&.fatal(Time.new.to_s + ' ' + message)
+        message = "#{message}#{exception}#{exception.backtrace&.join("\n")}" unless exception.nil?
+        @logger&.fatal("#{Time.new} #{message}")
       end
     end
   end
 
   module Levels
-    SEVERE = 'SEVERE'
+    SEVERE = 'FATAL'
     INFO = 'INFO'
-    WARNING = 'WARNING'
+    WARNING = 'WARN'
     ERROR = 'ERROR'
     DEBUG = 'DEBUG'
-    ALL = 'ALL'
+    ALL = 'DEBUG'
     OFF = 'OFF'
     FATAL = 'FATAL'
   end

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

@@ -2,8 +2,10 @@ require_relative '../util/model'
 
 module ZOHOCRMSDK
   module CustomViews
+    require_relative 'action_handler'
     class ActionWrapper
       include Util::Model
+      include ActionHandler
 
       # Creates an instance of ActionWrapper
       def initialize

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

@@ -286,18 +286,18 @@ module ZOHOCRMSDK
       end
 
         # The method to get the favorite
-        # @return A Boolean value
+        # @return A Integer value
 
       def favorite
         @favorite
       end
 
         # The method to set the value to favorite
-        # @param favorite [Boolean] A Boolean
+        # @param favorite [Integer] A Integer
 
       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)
+        if favorite!=nil and !favorite.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: favorite EXPECTED TYPE: Integer', nil, nil)
         end
         @favorite = favorite
         @key_modified['favorite'] = 1

data/src/com/zoho/crm/api/custom_views/custom_views_operations.rb

@@ -56,11 +56,76 @@ module ZOHOCRMSDK
         handler_instance.api_call(ResponseHandler.name, 'application/json')
       end
 
+        # The method to change sort order of custom views
+        # @param request [BodyWrapper] An instance of BodyWrapper
+        # @param param_instance [ParameterMap] An instance of ParameterMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def change_sort_order_of_custom_views(request, param_instance=nil)
+        if request!=nil and !request.is_a? BodyWrapper
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+        end
+        if param_instance!=nil and !param_instance.is_a? ParameterMap
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/crm/v6/settings/custom_views/actions/change_sort'
+        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
+        handler_instance.param = param_instance
+        require_relative 'action_handler'
+        handler_instance.api_call(ActionHandler.name, 'application/json')
+      end
+
+        # The method to change sort order of custom view
+        # @param id [Integer] A Integer
+        # @param request [BodyWrapper] An instance of BodyWrapper
+        # @param param_instance [ParameterMap] An instance of ParameterMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def change_sort_order_of_custom_view(id, request, param_instance=nil)
+        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
+        if param_instance!=nil and !param_instance.is_a? ParameterMap
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/crm/v6/settings/custom_views/'
+        api_path = api_path + id.to_s
+        api_path = api_path + '/actions/change_sort'
+        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.param = param_instance
+        require_relative 'action_handler'
+        handler_instance.api_call(ActionHandler.name, 'application/json')
+      end
+
       class GetCustomViewsParam
           @@module_1 =   Param.new('module', 'com.zoho.crm.api.CustomViews.GetCustomViewsParam')
         def self.module_1
           @@module_1
         end
+          @@page =   Param.new('page', 'com.zoho.crm.api.CustomViews.GetCustomViewsParam')
+        def self.page
+          @@page
+        end
+          @@per_page =   Param.new('per_page', 'com.zoho.crm.api.CustomViews.GetCustomViewsParam')
+        def self.per_page
+          @@per_page
+        end
       end
 
       class GetCustomViewParam
@@ -70,6 +135,20 @@ module ZOHOCRMSDK
         end
       end
 
+      class ChangeSortOrderOfCustomViewsParam
+          @@module_1 =   Param.new('module', 'com.zoho.crm.api.CustomViews.ChangeSortOrderOfCustomViewsParam')
+        def self.module_1
+          @@module_1
+        end
+      end
+
+      class ChangeSortOrderOfCustomViewParam
+          @@module_1 =   Param.new('module', 'com.zoho.crm.api.CustomViews.ChangeSortOrderOfCustomViewParam')
+        def self.module_1
+          @@module_1
+        end
+      end
+
     end
   end
 end

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

@@ -1,6 +1,6 @@
+require_relative '../record/record'
 require_relative '../tags/tag'
 require_relative '../users/minified_user'
-require_relative '../record/record'
 require_relative '../util/model'
 
 module ZOHOCRMSDK

data/src/com/zoho/crm/api/email_related_records/status.rb

@@ -14,6 +14,7 @@ module ZOHOCRMSDK
         @bounced_time = nil
         @bounced_reason = nil
         @category = nil
+        @sub_category = nil
         @key_modified = Hash.new
       end
 
@@ -143,6 +144,24 @@ module ZOHOCRMSDK
         @key_modified['category'] = 1
       end
 
+        # The method to get the sub_category
+        # @return A String value
+
+      def sub_category
+        @sub_category
+      end
+
+        # The method to set the value to sub_category
+        # @param sub_category [String] A String
+
+      def sub_category=(sub_category)
+        if sub_category!=nil and !sub_category.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sub_category EXPECTED TYPE: String', nil, nil)
+        end
+        @sub_category = sub_category
+        @key_modified['sub_category'] = 1
+      end
+
         # The method to check if the user has modified the given key
         # @param key [String] A String
         # @return A Integer value

data/src/com/zoho/crm/api/email_templates/email_template.rb

@@ -1,8 +1,8 @@
 require_relative '../inventory_templates/folder'
+require_relative '../inventory_templates/inventory_templates'
 require_relative '../inventory_templates/module_map'
 require_relative '../inventory_templates/user'
 require_relative '../send_mail/template'
-require_relative '../inventory_templates/inventory_templates'
 require_relative '../util/model'
 
 module ZOHOCRMSDK

data/src/com/zoho/crm/api/features/detail.rb

@@ -7,11 +7,30 @@ module ZOHOCRMSDK
 
       # Creates an instance of Detail
       def initialize
+        @available_count = nil
         @limits = nil
         @used_count = nil
         @key_modified = Hash.new
       end
 
+        # The method to get the available_count
+        # @return An instance of Limit
+
+      def available_count
+        @available_count
+      end
+
+        # The method to set the value to available_count
+        # @param available_count [Limit] An instance of Limit
+
+      def available_count=(available_count)
+        if available_count!=nil and !available_count.is_a? Limit
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: available_count EXPECTED TYPE: Limit', nil, nil)
+        end
+        @available_count = available_count
+        @key_modified['available_count'] = 1
+      end
+
         # The method to get the limits
         # @return An instance of Limit
 

data/src/com/zoho/crm/api/features/features_operations.rb

@@ -70,6 +70,20 @@ module ZOHOCRMSDK
         handler_instance.api_call(ResponseHandler.name, 'application/json')
       end
 
+        # The method to get user licences count
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_user_licences_count
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/crm/v6/__features/user_licenses'
+        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
+
       class GetFeatureDetailsParam
           @@module_1 =   Param.new('module', 'com.zoho.crm.api.Features.GetFeatureDetailsParam')
         def self.module_1

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

@@ -5,6 +5,7 @@ require_relative '../fields/crypt'
 require_relative '../fields/currency'
 require_relative '../fields/email_parser'
 require_relative '../fields/external'
+require_relative '../fields/fields'
 require_relative '../fields/file_upolad_option'
 require_relative '../fields/formula'
 require_relative '../fields/hipaa_compliance'
@@ -25,7 +26,6 @@ require_relative '../fields/unique'
 require_relative '../fields/view_type'
 require_relative '../modules/minified_module'
 require_relative '../modules/sharing_properties'
-require_relative '../fields/fields'
 require_relative '../util/model'
 
 module ZOHOCRMSDK

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

@@ -77,18 +77,18 @@ module ZOHOCRMSDK
       end
 
         # The method to get the tab_traversal
-        # @return A Integer value
+        # @return A String value
 
       def tab_traversal
         @tab_traversal
       end
 
         # The method to set the value to tab_traversal
-        # @param tab_traversal [Integer] A Integer
+        # @param tab_traversal [String] A String
 
       def tab_traversal=(tab_traversal)
-        if tab_traversal!=nil and !tab_traversal.is_a? Integer
-          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: tab_traversal EXPECTED TYPE: Integer', nil, nil)
+        if tab_traversal!=nil and !tab_traversal.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: tab_traversal EXPECTED TYPE: String', nil, nil)
         end
         @tab_traversal = tab_traversal
         @key_modified['tab_traversal'] = 1

data/src/com/zoho/crm/api/modules/module_field_lookup.rb

@@ -1,6 +1,6 @@
+require_relative '../fields/lookup'
 require_relative '../fields/query_details'
 require_relative '../fields/show_fields'
-require_relative '../fields/lookup'
 require_relative '../util/model'
 
 module ZOHOCRMSDK

data/src/com/zoho/crm/api/modules/module_fields.rb

@@ -5,6 +5,7 @@ require_relative '../fields/crypt'
 require_relative '../fields/currency'
 require_relative '../fields/email_parser'
 require_relative '../fields/external'
+require_relative '../fields/fields'
 require_relative '../fields/file_upolad_option'
 require_relative '../fields/formula'
 require_relative '../fields/hipaa_compliance'
@@ -23,7 +24,6 @@ require_relative '../fields/textarea'
 require_relative '../fields/tooltip'
 require_relative '../fields/unique'
 require_relative '../fields/view_type'
-require_relative '../fields/fields'
 require_relative '../util/model'
 
 module ZOHOCRMSDK

data/src/com/zoho/crm/api/record_locking/record_lock.rb

@@ -1,6 +1,6 @@
+require_relative '../record/record'
 require_relative '../tags/tag'
 require_relative '../users/minified_user'
-require_relative '../record/record'
 require_relative '../util/choice'
 require_relative '../util/model'
 

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

@@ -6,11 +6,13 @@ module ZOHOCRMSDK
     require_relative 'action_response'
     require_relative 'response_handler'
     require_relative 'action_handler'
+    require_relative 'count_handler'
     class APIException
       include Util::Model
       include ActionResponse
       include ResponseHandler
       include ActionHandler
+      include CountHandler
 
       # Creates an instance of APIException
       def initialize

data/src/com/zoho/crm/api/users/count_handler.rb

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

data/src/com/zoho/crm/api/users/count_wrapper.rb

@@ -0,0 +1,65 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Users
+    require_relative 'count_handler'
+    class CountWrapper
+      include Util::Model
+      include CountHandler
+
+      # Creates an instance of CountWrapper
+      def initialize
+        @count = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the count
+        # @return A Integer value
+
+      def count
+        @count
+      end
+
+        # The method to set the value to count
+        # @param count [Integer] A Integer
+
+      def count=(count)
+        if count!=nil and !count.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: Integer', nil, nil)
+        end
+        @count = count
+        @key_modified['count'] = 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/users/users.rb

@@ -1,5 +1,5 @@
-require_relative '../tags/tag'
 require_relative '../record/record'
+require_relative '../tags/tag'
 require_relative '../util/choice'
 require_relative '../util/model'
 

data/src/com/zoho/crm/api/users/users_operations.rb

@@ -171,6 +171,25 @@ module ZOHOCRMSDK
         handler_instance.api_call(ResponseHandler.name, 'application/json')
       end
 
+        # The method to users count
+        # @param param_instance [ParameterMap] An instance of ParameterMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def users_count(param_instance=nil)
+        if param_instance!=nil and !param_instance.is_a? ParameterMap
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/crm/v6/users/actions/count'
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_GET
+        handler_instance.category_method = 'READ'
+        handler_instance.param = param_instance
+        require_relative 'count_handler'
+        handler_instance.api_call(CountHandler.name, 'application/json')
+      end
+
       class GetUsersParam
           @@type =   Param.new('type', 'com.zoho.crm.api.Users.GetUsersParam')
         def self.type
@@ -204,6 +223,13 @@ module ZOHOCRMSDK
         end
       end
 
+      class UsersCountParam
+          @@type =   Param.new('type', 'com.zoho.crm.api.Users.UsersCountParam')
+        def self.type
+          @@type
+        end
+      end
+
     end
   end
 end

data/src/com/zoho/crm/api/util/constants.rb

@@ -175,7 +175,7 @@ module ZOHOCRMSDK
 
     ZOHO_SDK = 'X-ZOHO-SDK'
 
-    SDK_VERSION = '1.0.0'
+    SDK_VERSION = '2.0.0'
 
     SET_CONTENT_TYPE_HEADER = ['/crm/bulk/v6/read', '/crm/bulk/v6/write']