ZOHOCRMSDK2_1 1.0.0

data/src/com/zoho/crm/api/profiles/default_view.rb

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

@@ -0,0 +1,139 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Profiles
+    class PermissionDetail
+      include Util::Model
+
+      # Creates an instance of PermissionDetail
+      def initialize
+        @display_label = nil
+        @module_1 = nil
+        @name = nil
+        @id = nil
+        @enabled = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the display_label
+        # @return A String value
+
+      def display_label
+        @display_label
+      end
+
+        # The method to set the value to display_label
+        # @param display_label [String] A String
+
+      def display_label=(display_label)
+        if display_label!=nil and !display_label.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
+        end
+        @display_label = display_label
+        @key_modified['display_label'] = 1
+      end
+
+        # The method to get the module
+        # @return A String value
+
+      def module
+        @module_1
+      end
+
+        # The method to set the value to module
+        # @param module_1 [String] A String
+
+      def module=(module_1)
+        if module_1!=nil and !module_1.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: String', nil, nil)
+        end
+        @module_1 = module_1
+        @key_modified['module'] = 1
+      end
+
+        # The method to get the name
+        # @return A String value
+
+      def name
+        @name
+      end
+
+        # The method to set the value to name
+        # @param name [String] A String
+
+      def name=(name)
+        if name!=nil and !name.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
+        end
+        @name = name
+        @key_modified['name'] = 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 enabled
+        # @return A Boolean value
+
+      def enabled
+        @enabled
+      end
+
+        # The method to set the value to enabled
+        # @param enabled [Boolean] A Boolean
+
+      def enabled=(enabled)
+        if enabled!=nil and ! [true, false].include?enabled
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: enabled EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @enabled = enabled
+        @key_modified['enabled'] = 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/profiles/profile.rb

@@ -0,0 +1,330 @@
+require_relative '../users/user'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module Profiles
+    class Profile
+      include Util::Model
+
+      # Creates an instance of Profile
+      def initialize
+        @display_label = nil
+        @created_time = nil
+        @modified_time = nil
+        @permissions_details = nil
+        @name = nil
+        @modified_by = nil
+        @defaultview = nil
+        @default = nil
+        @description = nil
+        @id = nil
+        @custom = nil
+        @created_by = nil
+        @sections = nil
+        @delete = nil
+        @permission_type = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the display_label
+        # @return A String value
+
+      def display_label
+        @display_label
+      end
+
+        # The method to set the value to display_label
+        # @param display_label [String] A String
+
+      def display_label=(display_label)
+        if display_label!=nil and !display_label.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_label EXPECTED TYPE: String', nil, nil)
+        end
+        @display_label = display_label
+        @key_modified['display_label'] = 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 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 permissions_details
+        # @return An instance of Array
+
+      def permissions_details
+        @permissions_details
+      end
+
+        # The method to set the value to permissions_details
+        # @param permissions_details [Array] An instance of Array
+
+      def permissions_details=(permissions_details)
+        if permissions_details!=nil and !permissions_details.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: permissions_details EXPECTED TYPE: Array', nil, nil)
+        end
+        @permissions_details = permissions_details
+        @key_modified['permissions_details'] = 1
+      end
+
+        # The method to get the name
+        # @return A String value
+
+      def name
+        @name
+      end
+
+        # The method to set the value to name
+        # @param name [String] A String
+
+      def name=(name)
+        if name!=nil and !name.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
+        end
+        @name = name
+        @key_modified['name'] = 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 defaultview
+        # @return An instance of DefaultView
+
+      def defaultview
+        @defaultview
+      end
+
+        # The method to set the value to defaultview
+        # @param defaultview [DefaultView] An instance of DefaultView
+
+      def defaultview=(defaultview)
+        if defaultview!=nil and !defaultview.is_a? DefaultView
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: defaultview EXPECTED TYPE: DefaultView', nil, nil)
+        end
+        @defaultview = defaultview
+        @key_modified['_default_view'] = 1
+      end
+
+        # The method to get the default
+        # @return A Boolean value
+
+      def default
+        @default
+      end
+
+        # The method to set the value to default
+        # @param default [Boolean] A Boolean
+
+      def default=(default)
+        if default!=nil and ! [true, false].include?default
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @default = default
+        @key_modified['default'] = 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 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 custom
+        # @return A Boolean value
+
+      def custom
+        @custom
+      end
+
+        # The method to set the value to custom
+        # @param custom [Boolean] A Boolean
+
+      def custom=(custom)
+        if custom!=nil and ! [true, false].include?custom
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: custom EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @custom = custom
+        @key_modified['custom'] = 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 sections
+        # @return An instance of Array
+
+      def sections
+        @sections
+      end
+
+        # The method to set the value to sections
+        # @param sections [Array] An instance of Array
+
+      def sections=(sections)
+        if sections!=nil and !sections.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sections EXPECTED TYPE: Array', nil, nil)
+        end
+        @sections = sections
+        @key_modified['sections'] = 1
+      end
+
+        # The method to get the delete
+        # @return A Boolean value
+
+      def delete
+        @delete
+      end
+
+        # The method to set the value to delete
+        # @param delete [Boolean] A Boolean
+
+      def delete=(delete)
+        if delete!=nil and ! [true, false].include?delete
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: Boolean', nil, nil)
+        end
+        @delete = delete
+        @key_modified['_delete'] = 1
+      end
+
+        # The method to get the permission_type
+        # @return A String value
+
+      def permission_type
+        @permission_type
+      end
+
+        # The method to set the value to permission_type
+        # @param permission_type [String] A String
+
+      def permission_type=(permission_type)
+        if permission_type!=nil and !permission_type.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: permission_type EXPECTED TYPE: String', nil, nil)
+        end
+        @permission_type = permission_type
+        @key_modified['permission_type'] = 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/profiles/profiles_operations.rb

@@ -0,0 +1,63 @@
+require_relative '../header'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module ZOHOCRMSDK
+  module Profiles
+    class ProfilesOperations
+
+        # Creates an instance of ProfilesOperations with the given parameters
+        # @param if_modified_since [DateTime] An instance of DateTime
+      def initialize(if_modified_since=nil)
+        if if_modified_since!=nil and !if_modified_since.is_a? DateTime
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: if_modified_since EXPECTED TYPE: DateTime', nil, nil)
+        end
+        @if_modified_since = if_modified_since
+      end
+
+        # The method to get profiles
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_profiles
+        handler_instance = Handler::CommonAPIHandler.new
+        api_path = ''
+        api_path = api_path + '/crm/v2.1/settings/profiles'
+        handler_instance.api_path = api_path
+        handler_instance.http_method = Constants::REQUEST_METHOD_GET
+        handler_instance.category_method = 'READ'
+        handler_instance.add_header(Header.new('If-Modified-Since', 'com.zoho.crm.api.Profiles.GetProfilesHeader'), @if_modified_since)
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
+      end
+
+        # The method to get profile
+        # @param id [Integer] A Integer
+        # @return An instance of APIResponse
+      # @raise SDKException
+      def get_profile(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/v2.1/settings/profiles/'
+        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'
+        handler_instance.add_header(Header.new('If-Modified-Since', 'com.zoho.crm.api.Profiles.GetProfileHeader'), @if_modified_since)
+        require_relative 'response_handler'
+        handler_instance.api_call(ResponseHandler.name, 'application/json')
+      end
+
+      class GetProfilesHeader
+      end
+
+      class GetProfileHeader
+      end
+
+    end
+  end
+end

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

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

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

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