ZOHOCRMSDK2_0_docgo 6.2.0

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

@@ -0,0 +1,369 @@
+require_relative '../record/record'
+require_relative '../users/user'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  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
+        @file_id = nil
+        @type = nil
+        @se_module = nil
+        @modified_by = 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 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 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 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 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
+end

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

@@ -0,0 +1,198 @@
+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 ZOHOCRMSDK
+  module Attachments
+    class AttachmentsOperations
+
+        # Creates an instance of AttachmentsOperations with the given parameters
+        # @param module_api_name [String] A String
+        # @param record_id [Integer] A Integer
+      def initialize(module_api_name, record_id)
+        if !module_api_name.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: String', nil, nil)
+        end
+        if !record_id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: Integer', nil, nil)
+        end
+        @module_api_name = module_api_name
+        @record_id = record_id
+      end
+
+        # The method to download attachment
+        # @param id [Integer] A Integer
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def download_attachment(id)
+        if !id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
+        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 + '/Attachments/'
+        api_path = api_path + id.to_s
+        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/x-download')
+      end
+
+        # The method to delete attachment
+        # @param id [Integer] A Integer
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def delete_attachment(id)
+        if !id.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
+        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 + '/Attachments/'
+        api_path = api_path + id.to_s
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
+        handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
+        require_relative 'action_handler'
+        handler_instance.api_call(ActionHandler.name, 'application/json')
+      end
+
+        # The method to get attachments
+        # @param param_instance [ParameterMap] An instance of ParameterMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_attachments(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/v#{Initializer.get_initializer.api_version}/"
+        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 + '/Attachments'
+        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 upload attachment
+        # @param request [FileBodyWrapper] An instance of FileBodyWrapper
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def upload_attachment(request)
+        if request!=nil and !request.is_a? FileBodyWrapper
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', nil, nil)
+        end
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + "/crm/v#{Initializer.get_initializer.api_version}/"
+        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 + '/Attachments'
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_POST
+        handler_instance.category_method = 'CREATE'
+        handler_instance.content_type = 'multipart/form-data'
+        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 upload link attachment
+        # @param param_instance [ParameterMap] An instance of ParameterMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def upload_link_attachment(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/v#{Initializer.get_initializer.api_version}/"
+        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 + '/Attachments'
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_POST
+        handler_instance.category_method = 'CREATE'
+        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 delete attachments
+        # @param param_instance [ParameterMap] An instance of ParameterMap
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def delete_attachments(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/v#{Initializer.get_initializer.api_version}/"
+        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 + '/Attachments'
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
+        handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
+        handler_instance.param = param_instance
+        require_relative 'action_handler'
+        handler_instance.api_call(ActionHandler.name, 'application/json')
+      end
+
+      class GetAttachmentsParam
+          @@fields =   Param.new('fields', 'com.zoho.crm.api.Attachments.GetAttachmentsParam')
+        def self.fields
+          @@fields
+        end
+          @@page =   Param.new('page', 'com.zoho.crm.api.Attachments.GetAttachmentsParam')
+        def self.page
+          @@page
+        end
+          @@per_page =   Param.new('per_page', 'com.zoho.crm.api.Attachments.GetAttachmentsParam')
+        def self.per_page
+          @@per_page
+        end
+      end
+
+      class UploadLinkAttachmentParam
+          @@attachmentUrl =   Param.new('attachmentUrl', 'com.zoho.crm.api.Attachments.UploadLinkAttachmentParam')
+        def self.attachmentUrl
+          @@attachmentUrl
+        end
+      end
+
+      class DeleteAttachmentsParam
+          @@ids =   Param.new('ids', 'com.zoho.crm.api.Attachments.DeleteAttachmentsParam')
+        def self.ids
+          @@ids
+        end
+      end
+
+    end
+  end
+end

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

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

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