ZCRMSDK 2.0.0 → 3.0.0.beta

data/src/com/zoho/crm/api/wizards/segment.rb

@@ -0,0 +1,176 @@
+require_relative '../fields/field'
+require_relative '../util/model'
+
+module Wizards
+  class Segment
+    include Util::Model
+
+    # Creates an instance of Segment
+    def initialize
+      @id = nil
+      @sequence_number = nil
+      @display_label = nil
+      @type = nil
+      @column_count = nil
+      @fields = nil
+      @buttons = nil
+      @key_modified = Hash.new
+    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 sequence_number
+      # @return A Integer value
+
+    def sequence_number
+      @sequence_number
+    end
+
+      # The method to set the value to sequence_number
+      # @param sequence_number [Integer] A Integer
+
+    def sequence_number=(sequence_number)
+      if sequence_number!=nil and !sequence_number.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sequence_number EXPECTED TYPE: Integer', nil, nil)
+      end
+      @sequence_number = sequence_number
+      @key_modified['sequence_number'] = 1
+    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 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 column_count
+      # @return A Integer value
+
+    def column_count
+      @column_count
+    end
+
+      # The method to set the value to column_count
+      # @param column_count [Integer] A Integer
+
+    def column_count=(column_count)
+      if column_count!=nil and !column_count.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: column_count EXPECTED TYPE: Integer', nil, nil)
+      end
+      @column_count = column_count
+      @key_modified['column_count'] = 1
+    end
+
+      # The method to get the fields
+      # @return An instance of Array
+
+    def fields
+      @fields
+    end
+
+      # The method to set the value to fields
+      # @param fields [Array] An instance of Array
+
+    def fields=(fields)
+      if fields!=nil and !fields.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: Array', nil, nil)
+      end
+      @fields = fields
+      @key_modified['fields'] = 1
+    end
+
+      # The method to get the buttons
+      # @return An instance of Array
+
+    def buttons
+      @buttons
+    end
+
+      # The method to set the value to buttons
+      # @param buttons [Array] An instance of Array
+
+    def buttons=(buttons)
+      if buttons!=nil and !buttons.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: buttons EXPECTED TYPE: Array', nil, nil)
+      end
+      @buttons = buttons
+      @key_modified['buttons'] = 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/wizards/wizard.rb

@@ -0,0 +1,273 @@
+require_relative '../modules/module'
+require_relative '../profiles/profile'
+require_relative '../users/user'
+require_relative '../util/model'
+
+module Wizards
+  class Wizard
+    include Util::Model
+
+    # Creates an instance of Wizard
+    def initialize
+      @created_time = nil
+      @modified_time = nil
+      @module_1 = nil
+      @name = nil
+      @modified_by = nil
+      @profiles = nil
+      @active = nil
+      @containers = nil
+      @created_by = nil
+      @parent_wizard = nil
+      @draft = nil
+      @id = nil
+      @key_modified = Hash.new
+    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 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 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 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 get the active
+      # @return A Boolean value
+
+    def active
+      @active
+    end
+
+      # The method to set the value to active
+      # @param active [Boolean] A Boolean
+
+    def active=(active)
+      if active!=nil and ! [true, false].include?active
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @active = active
+      @key_modified['active'] = 1
+    end
+
+      # The method to get the containers
+      # @return An instance of Array
+
+    def containers
+      @containers
+    end
+
+      # The method to set the value to containers
+      # @param containers [Array] An instance of Array
+
+    def containers=(containers)
+      if containers!=nil and !containers.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: containers EXPECTED TYPE: Array', nil, nil)
+      end
+      @containers = containers
+      @key_modified['containers'] = 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 parent_wizard
+      # @return An instance of Wizard
+
+    def parent_wizard
+      @parent_wizard
+    end
+
+      # The method to set the value to parent_wizard
+      # @param parent_wizard [Wizard] An instance of Wizard
+
+    def parent_wizard=(parent_wizard)
+      if parent_wizard!=nil and !parent_wizard.is_a? Wizard
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: parent_wizard EXPECTED TYPE: Wizard', nil, nil)
+      end
+      @parent_wizard = parent_wizard
+      @key_modified['parent_wizard'] = 1
+    end
+
+      # The method to get the draft
+      # @return A Boolean value
+
+    def draft
+      @draft
+    end
+
+      # The method to set the value to draft
+      # @param draft [Boolean] A Boolean
+
+    def draft=(draft)
+      if draft!=nil and ! [true, false].include?draft
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: draft EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @draft = draft
+      @key_modified['draft'] = 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 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/wizards/wizards_operations.rb

@@ -0,0 +1,61 @@
+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 Wizards
+  class WizardsOperations
+
+    # Creates an instance of WizardsOperations
+    def initialize
+    end
+
+      # The method to get wizards
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_wizards
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2.1/settings/wizards'
+      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/json')
+    end
+
+      # The method to get wizard by id
+      # @param wizard_id [Integer] A Integer
+      # @param param_instance [ParameterMap] An instance of ParameterMap
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_wizard_by_id(wizard_id, param_instance=nil)
+      if !wizard_id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: wizard_id EXPECTED TYPE: Integer', nil, nil)
+      end
+      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.1/settings/wizards/'
+      api_path = api_path + wizard_id.to_s
+      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
+
+    class GetWizardbyIDParam
+      @@layout_id = Param.new('layout_id', 'com.zoho.crm.api.Wizards.GetWizardbyIDParam')
+      def self.layout_id
+        @@layout_id
+      end
+    end
+
+  end
+end