ZCRMSDK 1.0.4 → 3.0.0

data/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.rb

@@ -0,0 +1,82 @@
+require_relative '../param'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module InventoryTemplates
+  class InventoryTemplatesOperations
+
+      # Creates an instance of InventoryTemplatesOperations with the given parameters
+      # @param module_1 [String] A String
+      # @param sort_by [String] A String
+      # @param sort_order [String] A String
+      # @param category [String] A String
+    def initialize(module_1=nil, sort_by=nil, sort_order=nil, category=nil)
+      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
+      if sort_by!=nil and !sort_by.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: String', nil, nil)
+      end
+      if sort_order!=nil and !sort_order.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: String', nil, nil)
+      end
+      if category!=nil and !category.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: String', nil, nil)
+      end
+      @module_1 = module_1
+      @sort_by = sort_by
+      @sort_order = sort_order
+      @category = category
+    end
+
+      # The method to get inventory templates
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_inventory_templates
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2.1/settings/inventory_templates'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_GET
+      handler_instance.category_method = 'READ'
+      handler_instance.add_param(Param.new('module', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam'), @module_1)
+      handler_instance.add_param(Param.new('sort_by', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam'), @sort_by)
+      handler_instance.add_param(Param.new('sort_order', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam'), @sort_order)
+      handler_instance.add_param(Param.new('category', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam'), @category)
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+      # The method to get inventory template by id
+      # @param id [Integer] A Integer
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_inventory_template_by_id(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/inventory_templates/'
+      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_param(Param.new('module', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatebyIDParam'), @module_1)
+      handler_instance.add_param(Param.new('sort_by', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatebyIDParam'), @sort_by)
+      handler_instance.add_param(Param.new('sort_order', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatebyIDParam'), @sort_order)
+      handler_instance.add_param(Param.new('category', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatebyIDParam'), @category)
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+    class GetInventoryTemplatesParam
+    end
+
+    class GetInventoryTemplatebyIDParam
+    end
+
+  end
+end

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

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

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

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

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Layouts
+  require_relative 'response_handler'
+  class APIException
+    include Util::Model
+    include ResponseHandler
+
+    # 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/layouts/layout.rb

@@ -0,0 +1,310 @@
+require_relative '../profiles/profile'
+require_relative '../users/user'
+require_relative '../util/model'
+
+module Layouts
+  class Layout
+    include Util::Model
+
+    # Creates an instance of Layout
+    def initialize
+      @created_time = nil
+      @convert_mapping = nil
+      @modified_time = nil
+      @visible = nil
+      @created_for = nil
+      @name = nil
+      @modified_by = nil
+      @profiles = nil
+      @id = nil
+      @created_by = nil
+      @sections = nil
+      @status = nil
+      @display_type = nil
+      @show_business_card = 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 convert_mapping
+      # @return An instance of Hash
+
+    def convert_mapping
+      @convert_mapping
+    end
+
+      # The method to set the value to convert_mapping
+      # @param convert_mapping [Hash] An instance of Hash
+
+    def convert_mapping=(convert_mapping)
+      if convert_mapping!=nil and !convert_mapping.is_a? Hash
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: Hash', nil, nil)
+      end
+      @convert_mapping = convert_mapping
+      @key_modified['convert_mapping'] = 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 visible
+      # @return A Boolean value
+
+    def visible
+      @visible
+    end
+
+      # The method to set the value to visible
+      # @param visible [Boolean] A Boolean
+
+    def visible=(visible)
+      if visible!=nil and ! [true, false].include?visible
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @visible = visible
+      @key_modified['visible'] = 1
+    end
+
+      # The method to get the created_for
+      # @return An instance of Users::User
+
+    def created_for
+      @created_for
+    end
+
+      # The method to set the value to created_for
+      # @param created_for [Users::User] An instance of Users::User
+
+    def created_for=(created_for)
+      if created_for!=nil and !created_for.is_a? Users::User
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_for EXPECTED TYPE: User', nil, nil)
+      end
+      @created_for = created_for
+      @key_modified['created_for'] = 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 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 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 status
+      # @return A Integer value
+
+    def status
+      @status
+    end
+
+      # The method to set the value to status
+      # @param status [Integer] A Integer
+
+    def status=(status)
+      if status!=nil and !status.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Integer', nil, nil)
+      end
+      @status = status
+      @key_modified['status'] = 1
+    end
+
+      # The method to get the display_type
+      # @return A Integer value
+
+    def display_type
+      @display_type
+    end
+
+      # The method to set the value to display_type
+      # @param display_type [Integer] A Integer
+
+    def display_type=(display_type)
+      if display_type!=nil and !display_type.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: Integer', nil, nil)
+      end
+      @display_type = display_type
+      @key_modified['display_type'] = 1
+    end
+
+      # The method to get the show_business_card
+      # @return A Boolean value
+
+    def show_business_card
+      @show_business_card
+    end
+
+      # The method to set the value to show_business_card
+      # @param show_business_card [Boolean] A Boolean
+
+    def show_business_card=(show_business_card)
+      if show_business_card!=nil and ! [true, false].include?show_business_card
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: show_business_card EXPECTED TYPE: Boolean', nil, nil)
+      end
+      @show_business_card = show_business_card
+      @key_modified['show_business_card'] = 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