ZOHOCRMSDK2_0 1.0.0 → 5.0.0

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

@@ -1,83 +1,85 @@
 require_relative '../users/user'
 require_relative '../util/model'
 
-module ShareRecords
-  require_relative 'response_handler'
-  class ResponseWrapper
-    include Util::Model
-    include ResponseHandler
-
-    # Creates an instance of ResponseWrapper
-    def initialize
-      @share = nil
-      @shareable_user = nil
-      @key_modified = Hash.new
-    end
-
-      # The method to get the share
-      # @return An instance of Array
-
-    def share
-      @share
-    end
+module ZOHOCRMSDK
+  module ShareRecords
+    require_relative 'response_handler'
+    class ResponseWrapper
+      include Util::Model
+      include ResponseHandler
+
+      # Creates an instance of ResponseWrapper
+      def initialize
+        @share = nil
+        @shareable_user = nil
+        @key_modified = Hash.new
+      end
 
-      # The method to set the value to share
-      # @param share [Array] An instance of Array
+        # The method to get the share
+        # @return An instance of Array
 
-    def share=(share)
-      if share!=nil and !share.is_a? Array
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: share EXPECTED TYPE: Array', nil, nil)
+      def share
+        @share
       end
-      @share = share
-      @key_modified['share'] = 1
-    end
 
-      # The method to get the shareable_user
-      # @return An instance of Array
+        # The method to set the value to share
+        # @param share [Array] An instance of Array
 
-    def shareable_user
-      @shareable_user
-    end
+      def share=(share)
+        if share!=nil and !share.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: share EXPECTED TYPE: Array', nil, nil)
+        end
+        @share = share
+        @key_modified['share'] = 1
+      end
 
-      # The method to set the value to shareable_user
-      # @param shareable_user [Array] An instance of Array
+        # The method to get the shareable_user
+        # @return An instance of Array
 
-    def shareable_user=(shareable_user)
-      if shareable_user!=nil and !shareable_user.is_a? Array
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shareable_user EXPECTED TYPE: Array', nil, nil)
+      def shareable_user
+        @shareable_user
       end
-      @shareable_user = shareable_user
-      @key_modified['shareable_user'] = 1
-    end
 
-      # The method to check if the user has modified the given key
-      # @param key [String] A String
-      # @return A Integer value
+        # The method to set the value to shareable_user
+        # @param shareable_user [Array] An instance of Array
 
-    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]
+      def shareable_user=(shareable_user)
+        if shareable_user!=nil and !shareable_user.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shareable_user EXPECTED TYPE: Array', nil, nil)
+        end
+        @shareable_user = shareable_user
+        @key_modified['shareable_user'] = 1
       end
 
-      nil
-    end
+        # The method to check if the user has modified the given key
+        # @param key [String] A String
+        # @return A Integer value
 
-      # The method to mark the given key as modified
-      # @param key [String] A String
-      # @param modification [Integer] A Integer
+      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
 
-    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)
+        nil
       end
-      if modification!=nil and !modification.is_a? Integer
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+
+        # 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
-      @key_modified[key] = modification
-    end
 
+    end
   end
 end

data/src/com/zoho/crm/api/share_records/share_record.rb

@@ -1,157 +1,159 @@
 require_relative '../users/user'
 require_relative '../util/model'
 
-module ShareRecords
-  class ShareRecord
-    include Util::Model
-
-    # Creates an instance of ShareRecord
-    def initialize
-      @share_related_records = nil
-      @shared_through = nil
-      @shared_time = nil
-      @permission = nil
-      @shared_by = nil
-      @user = nil
-      @key_modified = Hash.new
-    end
-
-      # The method to get the share_related_records
-      # @return A Boolean value
-
-    def share_related_records
-      @share_related_records
-    end
+module ZOHOCRMSDK
+  module ShareRecords
+    class ShareRecord
+      include Util::Model
+
+      # Creates an instance of ShareRecord
+      def initialize
+        @share_related_records = nil
+        @shared_through = nil
+        @shared_time = nil
+        @permission = nil
+        @shared_by = nil
+        @user = nil
+        @key_modified = Hash.new
+      end
 
-      # The method to set the value to share_related_records
-      # @param share_related_records [Boolean] A Boolean
+        # The method to get the share_related_records
+        # @return A Boolean value
 
-    def share_related_records=(share_related_records)
-      if share_related_records!=nil and ! [true, false].include?share_related_records
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: share_related_records EXPECTED TYPE: Boolean', nil, nil)
+      def share_related_records
+        @share_related_records
       end
-      @share_related_records = share_related_records
-      @key_modified['share_related_records'] = 1
-    end
 
-      # The method to get the shared_through
-      # @return An instance of SharedThrough
+        # The method to set the value to share_related_records
+        # @param share_related_records [Boolean] A Boolean
 
-    def shared_through
-      @shared_through
-    end
+      def share_related_records=(share_related_records)
+        if share_related_records!=nil and ! [true, false].include?share_related_records
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: share_related_records EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @share_related_records = share_related_records
+        @key_modified['share_related_records'] = 1
+      end
 
-      # The method to set the value to shared_through
-      # @param shared_through [SharedThrough] An instance of SharedThrough
+        # The method to get the shared_through
+        # @return An instance of SharedThrough
 
-    def shared_through=(shared_through)
-      if shared_through!=nil and !shared_through.is_a? SharedThrough
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_through EXPECTED TYPE: SharedThrough', nil, nil)
+      def shared_through
+        @shared_through
       end
-      @shared_through = shared_through
-      @key_modified['shared_through'] = 1
-    end
 
-      # The method to get the shared_time
-      # @return An instance of DateTime
+        # The method to set the value to shared_through
+        # @param shared_through [SharedThrough] An instance of SharedThrough
 
-    def shared_time
-      @shared_time
-    end
+      def shared_through=(shared_through)
+        if shared_through!=nil and !shared_through.is_a? SharedThrough
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_through EXPECTED TYPE: SharedThrough', nil, nil)
+        end
+        @shared_through = shared_through
+        @key_modified['shared_through'] = 1
+      end
 
-      # The method to set the value to shared_time
-      # @param shared_time [DateTime] An instance of DateTime
+        # The method to get the shared_time
+        # @return An instance of DateTime
 
-    def shared_time=(shared_time)
-      if shared_time!=nil and !shared_time.is_a? DateTime
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_time EXPECTED TYPE: DateTime', nil, nil)
+      def shared_time
+        @shared_time
       end
-      @shared_time = shared_time
-      @key_modified['shared_time'] = 1
-    end
 
-      # The method to get the permission
-      # @return A String value
+        # The method to set the value to shared_time
+        # @param shared_time [DateTime] An instance of DateTime
 
-    def permission
-      @permission
-    end
+      def shared_time=(shared_time)
+        if shared_time!=nil and !shared_time.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_time EXPECTED TYPE: DateTime', nil, nil)
+        end
+        @shared_time = shared_time
+        @key_modified['shared_time'] = 1
+      end
 
-      # The method to set the value to permission
-      # @param permission [String] A String
+        # The method to get the permission
+        # @return A String value
 
-    def permission=(permission)
-      if permission!=nil and !permission.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: permission EXPECTED TYPE: String', nil, nil)
+      def permission
+        @permission
       end
-      @permission = permission
-      @key_modified['permission'] = 1
-    end
 
-      # The method to get the shared_by
-      # @return An instance of Users::User
+        # The method to set the value to permission
+        # @param permission [String] A String
 
-    def shared_by
-      @shared_by
-    end
+      def permission=(permission)
+        if permission!=nil and !permission.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: permission EXPECTED TYPE: String', nil, nil)
+        end
+        @permission = permission
+        @key_modified['permission'] = 1
+      end
 
-      # The method to set the value to shared_by
-      # @param shared_by [Users::User] An instance of Users::User
+        # The method to get the shared_by
+        # @return An instance of Users::User
 
-    def shared_by=(shared_by)
-      if shared_by!=nil and !shared_by.is_a? Users::User
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_by EXPECTED TYPE: User', nil, nil)
+      def shared_by
+        @shared_by
       end
-      @shared_by = shared_by
-      @key_modified['shared_by'] = 1
-    end
 
-      # The method to get the user
-      # @return An instance of Users::User
+        # The method to set the value to shared_by
+        # @param shared_by [Users::User] An instance of Users::User
 
-    def user
-      @user
-    end
+      def shared_by=(shared_by)
+        if shared_by!=nil and !shared_by.is_a? Users::User
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: shared_by EXPECTED TYPE: User', nil, nil)
+        end
+        @shared_by = shared_by
+        @key_modified['shared_by'] = 1
+      end
 
-      # The method to set the value to user
-      # @param user [Users::User] An instance of Users::User
+        # The method to get the user
+        # @return An instance of Users::User
 
-    def user=(user)
-      if user!=nil and !user.is_a? Users::User
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: User', nil, nil)
+      def user
+        @user
       end
-      @user = user
-      @key_modified['user'] = 1
-    end
 
-      # The method to check if the user has modified the given key
-      # @param key [String] A String
-      # @return A Integer value
+        # The method to set the value to user
+        # @param user [Users::User] An instance of Users::User
 
-    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]
+      def user=(user)
+        if user!=nil and !user.is_a? Users::User
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: User', nil, nil)
+        end
+        @user = user
+        @key_modified['user'] = 1
       end
 
-      nil
-    end
+        # The method to check if the user has modified the given key
+        # @param key [String] A String
+        # @return A Integer value
 
-      # The method to mark the given key as modified
-      # @param key [String] A String
-      # @param modification [Integer] A Integer
+      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
 
-    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)
+        nil
       end
-      if modification!=nil and !modification.is_a? Integer
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+
+        # 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
-      @key_modified[key] = modification
-    end
 
+    end
   end
 end

data/src/com/zoho/crm/api/share_records/share_records_operations.rb

@@ -5,124 +5,126 @@ require_relative '../util/api_response'
 require_relative '../util/common_api_handler'
 require_relative '../util/constants'
 
-module ShareRecords
-  class ShareRecordsOperations
+module ZOHOCRMSDK
+  module ShareRecords
+    class ShareRecordsOperations
 
-      # Creates an instance of ShareRecordsOperations with the given parameters
-      # @param record_id [Integer] A Integer
-      # @param module_api_name [String] A String
-    def initialize(record_id, module_api_name)
-      if !record_id.is_a? Integer
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
+        # Creates an instance of ShareRecordsOperations with the given parameters
+        # @param record_id [Integer] A Integer
+        # @param module_api_name [String] A String
+      def initialize(record_id, module_api_name)
+        if !record_id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
+        end
+        if !module_api_name.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
+        end
+        @record_id = record_id
+        @module_api_name = module_api_name
       end
-      if !module_api_name.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
-      end
-      @record_id = record_id
-      @module_api_name = module_api_name
-    end
 
-      # The method to get shared record details
-      # @param param_instance [ParameterMap] An instance of ParameterMap
-      # @return An instance of APIResponse
-    # @raise SDKException
-    def get_shared_record_details(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)
+        # The method to get shared record details
+        # @param param_instance [ParameterMap] An instance of ParameterMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_shared_record_details(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/v2/'
+        api_path = api_path + @module_api_name.to_s
+        api_path = api_path + '/'
+        api_path = api_path + @record_id.to_s
+        api_path = api_path + '/actions/share'
+        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 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
       end
-      handler_instance = Handler::CommonAPIHandler.new
-      api_path = ''
-      api_path = api_path + '/crm/v2/'
-      api_path = api_path + @module_api_name.to_s
-      api_path = api_path + '/'
-      api_path = api_path + @record_id.to_s
-      api_path = api_path + '/actions/share'
-      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 'response_handler'
-      handler_instance.api_call(ResponseHandler.name, 'application/json')
-    end
 
-      # The method to share record
-      # @param request [BodyWrapper] An instance of BodyWrapper
-      # @return An instance of APIResponse
-    # @raise SDKException
-    def share_record(request)
-      if request!=nil and !request.is_a? BodyWrapper
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+        # The method to share record
+        # @param request [BodyWrapper] An instance of BodyWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def share_record(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/'
+        api_path = api_path + @module_api_name.to_s
+        api_path = api_path + '/'
+        api_path = api_path + @record_id.to_s
+        api_path = api_path + '/actions/share'
+        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
-      handler_instance = Handler::CommonAPIHandler.new
-      api_path = ''
-      api_path = api_path + '/crm/v2/'
-      api_path = api_path + @module_api_name.to_s
-      api_path = api_path + '/'
-      api_path = api_path + @record_id.to_s
-      api_path = api_path + '/actions/share'
-      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 share permissions
-      # @param request [BodyWrapper] An instance of BodyWrapper
-      # @return An instance of APIResponse
-    # @raise SDKException
-    def update_share_permissions(request)
-      if request!=nil and !request.is_a? BodyWrapper
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+        # The method to update share permissions
+        # @param request [BodyWrapper] An instance of BodyWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def update_share_permissions(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/'
+        api_path = api_path + @module_api_name.to_s
+        api_path = api_path + '/'
+        api_path = api_path + @record_id.to_s
+        api_path = api_path + '/actions/share'
+        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
-      handler_instance = Handler::CommonAPIHandler.new
-      api_path = ''
-      api_path = api_path + '/crm/v2/'
-      api_path = api_path + @module_api_name.to_s
-      api_path = api_path + '/'
-      api_path = api_path + @record_id.to_s
-      api_path = api_path + '/actions/share'
-      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 revoke shared record
-      # @return An instance of APIResponse
-    # @raise SDKException
-    def revoke_shared_record
-      handler_instance = Handler::CommonAPIHandler.new
-      api_path = ''
-      api_path = api_path + '/crm/v2/'
-      api_path = api_path + @module_api_name.to_s
-      api_path = api_path + '/'
-      api_path = api_path + @record_id.to_s
-      api_path = api_path + '/actions/share'
-      handler_instance.api_path = api_path
-      handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
-      handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
-      require_relative 'delete_action_handler'
-      handler_instance.api_call(DeleteActionHandler.name, 'application/json')
-    end
-
-    class GetSharedRecordDetailsParam
-      @@sharedTo = Param.new('sharedTo', 'com.zoho.crm.api.ShareRecords.GetSharedRecordDetailsParam')
-      def self.sharedTo
-        @@sharedTo
+        # The method to revoke shared record
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def revoke_shared_record
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/crm/v2/'
+        api_path = api_path + @module_api_name.to_s
+        api_path = api_path + '/'
+        api_path = api_path + @record_id.to_s
+        api_path = api_path + '/actions/share'
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
+        handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
+        require_relative 'delete_action_handler'
+        handler_instance.api_call(DeleteActionHandler.name, 'application/json')
       end
-      @@view = Param.new('view', 'com.zoho.crm.api.ShareRecords.GetSharedRecordDetailsParam')
-      def self.view
-        @@view
+
+      class GetSharedRecordDetailsParam
+          @@sharedTo =   Param.new('sharedTo', 'com.zoho.crm.api.ShareRecords.GetSharedRecordDetailsParam')
+        def self.sharedTo
+          @@sharedTo
+        end
+          @@view =   Param.new('view', 'com.zoho.crm.api.ShareRecords.GetSharedRecordDetailsParam')
+        def self.view
+          @@view
+        end
       end
-    end
 
+    end
   end
 end