ZCRMSDK 1.0.5 → 2.0.0

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

@@ -0,0 +1,10 @@
+module ShareRecords
+  module ResponseHandler
+
+    # Creates an instance of ResponseHandler
+    def initialize
+    end
+
+
+  end
+end

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

@@ -0,0 +1,83 @@
+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
+
+      # The method to set the value to share
+      # @param share [Array] 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)
+      end
+      @share = share
+      @key_modified['share'] = 1
+    end
+
+      # The method to get the shareable_user
+      # @return An instance of Array
+
+    def shareable_user
+      @shareable_user
+    end
+
+      # The method to set the value to shareable_user
+      # @param shareable_user [Array] 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)
+      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
+
+    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

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

@@ -0,0 +1,157 @@
+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
+
+      # The method to set the value to share_related_records
+      # @param share_related_records [Boolean] A Boolean
+
+    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 get the shared_through
+      # @return An instance of SharedThrough
+
+    def shared_through
+      @shared_through
+    end
+
+      # The method to set the value to shared_through
+      # @param shared_through [SharedThrough] 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)
+      end
+      @shared_through = shared_through
+      @key_modified['shared_through'] = 1
+    end
+
+      # The method to get the shared_time
+      # @return An instance of DateTime
+
+    def shared_time
+      @shared_time
+    end
+
+      # The method to set the value to shared_time
+      # @param shared_time [DateTime] 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)
+      end
+      @shared_time = shared_time
+      @key_modified['shared_time'] = 1
+    end
+
+      # The method to get the permission
+      # @return A String value
+
+    def permission
+      @permission
+    end
+
+      # The method to set the value to permission
+      # @param permission [String] A String
+
+    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 get the shared_by
+      # @return An instance of Users::User
+
+    def shared_by
+      @shared_by
+    end
+
+      # The method to set the value to shared_by
+      # @param shared_by [Users::User] 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)
+      end
+      @shared_by = shared_by
+      @key_modified['shared_by'] = 1
+    end
+
+      # The method to get the user
+      # @return An instance of Users::User
+
+    def user
+      @user
+    end
+
+      # The method to set the value to user
+      # @param user [Users::User] 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)
+      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
+
+    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

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

@@ -0,0 +1,128 @@
+require_relative '../param'
+require_relative '../parameter_map'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+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)
+      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)
+      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)
+      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)
+      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
+      end
+      @@view = Param.new('view', 'com.zoho.crm.api.ShareRecords.GetSharedRecordDetailsParam')
+      def self.view
+        @@view
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,100 @@
+require_relative '../modules/module'
+require_relative '../util/model'
+
+module ShareRecords
+  class SharedThrough
+    include Util::Model
+
+    # Creates an instance of SharedThrough
+    def initialize
+      @module_1 = nil
+      @id = nil
+      @entity_name = nil
+      @key_modified = Hash.new
+    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 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 entity_name
+      # @return A String value
+
+    def entity_name
+      @entity_name
+    end
+
+      # The method to set the value to entity_name
+      # @param entity_name [String] A String
+
+    def entity_name=(entity_name)
+      if entity_name!=nil and !entity_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: entity_name EXPECTED TYPE: String', nil, nil)
+      end
+      @entity_name = entity_name
+      @key_modified['entity_name'] = 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