ZCRMSDK 1.0.4 → 3.0.0

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

@@ -0,0 +1,63 @@
+require_relative '../util/model'
+
+module Attachments
+  require_relative 'action_handler'
+  class ActionWrapper
+    include Util::Model
+    include ActionHandler
+
+    # Creates an instance of ActionWrapper
+    def initialize
+      @data = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the data
+      # @return An instance of Array
+
+    def data
+      @data
+    end
+
+      # The method to set the value to data
+      # @param data [Array] An instance of Array
+
+    def data=(data)
+      if data!=nil and !data.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: Array', nil, nil)
+      end
+      @data = data
+      @key_modified['data'] = 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/attachments/api_exception.rb

@@ -0,0 +1,125 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Attachments
+  require_relative 'response_handler'
+  require_relative 'action_response'
+  require_relative 'action_handler'
+  class APIException
+    include Util::Model
+    include ResponseHandler
+    include ActionResponse
+    include ActionHandler
+
+    # 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

data/src/com/zoho/crm/api/attachments/attachment.rb

@@ -0,0 +1,405 @@
+require_relative '../record/record'
+require_relative '../users/user'
+require_relative '../util/model'
+
+module Attachments
+  class Attachment
+    include Util::Model
+
+    # Creates an instance of Attachment
+    def initialize
+      @owner = nil
+      @modified_time = nil
+      @file_name = nil
+      @created_time = nil
+      @size = nil
+      @parent_id = nil
+      @editable = nil
+      @sharing_permission = nil
+      @file_id = nil
+      @type = nil
+      @se_module = nil
+      @modified_by = nil
+      @attachment_type = nil
+      @state = nil
+      @id = nil
+      @created_by = nil
+      @link_url = nil
+      @description = nil
+      @category = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the owner
+      # @return An instance of Users::User
+
+    def owner
+      @owner
+    end
+
+      # The method to set the value to owner
+      # @param owner [Users::User] An instance of Users::User
+
+    def owner=(owner)
+      if owner!=nil and !owner.is_a? Users::User
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: User', nil, nil)
+      end
+      @owner = owner
+      @key_modified['Owner'] = 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 file_name
+      # @return A String value
+
+    def file_name
+      @file_name
+    end
+
+      # The method to set the value to file_name
+      # @param file_name [String] A String
+
+    def file_name=(file_name)
+      if file_name!=nil and !file_name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: String', nil, nil)
+      end
+      @file_name = file_name
+      @key_modified['File_Name'] = 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 size
+      # @return A Integer value
+
+    def size
+      @size
+    end
+
+      # The method to set the value to size
+      # @param size [Integer] A Integer
+
+    def size=(size)
+      if size!=nil and !size.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: size EXPECTED TYPE: Integer', nil, nil)
+      end
+      @size = size
+      @key_modified['Size'] = 1
+    end
+
+      # The method to get the parent_id
+      # @return An instance of Record::Record
+
+    def parent_id
+      @parent_id
+    end
+
+      # The method to set the value to parent_id
+      # @param parent_id [Record::Record] An instance of Record::Record
+
+    def parent_id=(parent_id)
+      if parent_id!=nil and !parent_id.is_a? Record::Record
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: parent_id EXPECTED TYPE: Record', nil, nil)
+      end
+      @parent_id = parent_id
+      @key_modified['Parent_Id'] = 1
+    end
+
+      # The method to get the editable
+      # @return A Boolean value
+
+    def editable
+      @editable
+    end
+
+      # The method to set the value to editable
+      # @param editable [Boolean] A Boolean
+
+    def editable=(editable)
+      if editable!=nil and ! [true, false].include?editable
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: editable EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @editable = editable
+      @key_modified['$editable'] = 1
+    end
+
+      # The method to get the sharing_permission
+      # @return A String value
+
+    def sharing_permission
+      @sharing_permission
+    end
+
+      # The method to set the value to sharing_permission
+      # @param sharing_permission [String] A String
+
+    def sharing_permission=(sharing_permission)
+      if sharing_permission!=nil and !sharing_permission.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sharing_permission EXPECTED TYPE: String', nil, nil)
+      end
+      @sharing_permission = sharing_permission
+      @key_modified['$sharing_permission'] = 1
+    end
+
+      # The method to get the file_id
+      # @return A String value
+
+    def file_id
+      @file_id
+    end
+
+      # The method to set the value to file_id
+      # @param file_id [String] A String
+
+    def file_id=(file_id)
+      if file_id!=nil and !file_id.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: file_id EXPECTED TYPE: String', nil, nil)
+      end
+      @file_id = file_id
+      @key_modified['$file_id'] = 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 se_module
+      # @return A String value
+
+    def se_module
+      @se_module
+    end
+
+      # The method to set the value to se_module
+      # @param se_module [String] A String
+
+    def se_module=(se_module)
+      if se_module!=nil and !se_module.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: se_module EXPECTED TYPE: String', nil, nil)
+      end
+      @se_module = se_module
+      @key_modified['$se_module'] = 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 attachment_type
+      # @return A Integer value
+
+    def attachment_type
+      @attachment_type
+    end
+
+      # The method to set the value to attachment_type
+      # @param attachment_type [Integer] A Integer
+
+    def attachment_type=(attachment_type)
+      if attachment_type!=nil and !attachment_type.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: attachment_type EXPECTED TYPE: Integer', nil, nil)
+      end
+      @attachment_type = attachment_type
+      @key_modified['$attachment_type'] = 1
+    end
+
+      # The method to get the state
+      # @return A String value
+
+    def state
+      @state
+    end
+
+      # The method to set the value to state
+      # @param state [String] A String
+
+    def state=(state)
+      if state!=nil and !state.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: String', nil, nil)
+      end
+      @state = state
+      @key_modified['$state'] = 1
+    end
+
+      # The method to get the id
+      # @return A String value
+
+    def id
+      @id
+    end
+
+      # The method to set the value to id
+      # @param id [String] A String
+
+    def id=(id)
+      if id!=nil and !id.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: String', 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 link_url
+      # @return A String value
+
+    def link_url
+      @link_url
+    end
+
+      # The method to set the value to link_url
+      # @param link_url [String] A String
+
+    def link_url=(link_url)
+      if link_url!=nil and !link_url.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: link_url EXPECTED TYPE: String', nil, nil)
+      end
+      @link_url = link_url
+      @key_modified['$link_url'] = 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 category
+      # @return A String value
+
+    def category
+      @category
+    end
+
+      # The method to set the value to category
+      # @param category [String] A String
+
+    def category=(category)
+      if category!=nil and !category.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: String', nil, nil)
+      end
+      @category = category
+      @key_modified['category'] = 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