ZCRMSDK 2.0.0 → 3.0.0.beta

data/src/com/zoho/crm/api/taxes/taxes_operations.rb

@@ -18,7 +18,7 @@ module Taxes
     def get_taxes
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/org/taxes'
+      api_path = api_path + '/crm/v2.1/org/taxes'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET
       handler_instance.category_method = 'READ'
@@ -36,7 +36,7 @@ module Taxes
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/org/taxes'
+      api_path = api_path + '/crm/v2.1/org/taxes'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_POST
       handler_instance.category_method = 'CREATE'
@@ -57,7 +57,7 @@ module Taxes
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/org/taxes'
+      api_path = api_path + '/crm/v2.1/org/taxes'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_PUT
       handler_instance.category_method = 'UPDATE'
@@ -78,7 +78,7 @@ module Taxes
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/org/taxes'
+      api_path = api_path + '/crm/v2.1/org/taxes'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
       handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
@@ -97,7 +97,7 @@ module Taxes
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/org/taxes/'
+      api_path = api_path + '/crm/v2.1/org/taxes/'
       api_path = api_path + id.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET
@@ -116,7 +116,7 @@ module Taxes
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/org/taxes/'
+      api_path = api_path + '/crm/v2.1/org/taxes/'
       api_path = api_path + id.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_DELETE

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

@@ -1,3 +1,4 @@
+require_relative '../record/info'
 require_relative '../util/model'
 
 module Territories
@@ -9,6 +10,7 @@ module Territories
     # Creates an instance of ResponseWrapper
     def initialize
       @territories = nil
+      @info = nil
       @key_modified = Hash.new
     end
 
@@ -30,6 +32,24 @@ module Territories
       @key_modified['territories'] = 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

data/src/com/zoho/crm/api/territories/territories_operations.rb

@@ -16,7 +16,7 @@ module Territories
     def get_territories
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/settings/territories'
+      api_path = api_path + '/crm/v2.1/settings/territories'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET
       handler_instance.category_method = 'READ'
@@ -34,7 +34,7 @@ module Territories
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/settings/territories/'
+      api_path = api_path + '/crm/v2.1/settings/territories/'
       api_path = api_path + id.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET

data/src/com/zoho/crm/api/territories/territory.rb

@@ -11,13 +11,15 @@ module Territories
       @created_time = nil
       @modified_time = nil
       @manager = nil
-      @parent_id = nil
-      @criteria = nil
+      @account_rule_criteria = nil
+      @deal_rule_criteria = nil
       @name = nil
       @modified_by = nil
       @description = nil
       @id = nil
       @created_by = nil
+      @reporting_to = nil
+      @permission_type = nil
       @key_modified = Hash.new
     end
 
@@ -75,40 +77,40 @@ module Territories
       @key_modified['manager'] = 1
     end
 
-      # The method to get the parent_id
-      # @return A String value
+      # The method to get the account_rule_criteria
+      # @return An instance of CustomViews::Criteria
 
-    def parent_id
-      @parent_id
+    def account_rule_criteria
+      @account_rule_criteria
     end
 
-      # The method to set the value to parent_id
-      # @param parent_id [String] A String
+      # The method to set the value to account_rule_criteria
+      # @param account_rule_criteria [CustomViews::Criteria] An instance of CustomViews::Criteria
 
-    def parent_id=(parent_id)
-      if parent_id!=nil and !parent_id.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: parent_id EXPECTED TYPE: String', nil, nil)
+    def account_rule_criteria=(account_rule_criteria)
+      if account_rule_criteria!=nil and !account_rule_criteria.is_a? CustomViews::Criteria
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: account_rule_criteria EXPECTED TYPE: Criteria', nil, nil)
       end
-      @parent_id = parent_id
-      @key_modified['parent_id'] = 1
+      @account_rule_criteria = account_rule_criteria
+      @key_modified['account_rule_criteria'] = 1
     end
 
-      # The method to get the criteria
+      # The method to get the deal_rule_criteria
       # @return An instance of CustomViews::Criteria
 
-    def criteria
-      @criteria
+    def deal_rule_criteria
+      @deal_rule_criteria
     end
 
-      # The method to set the value to criteria
-      # @param criteria [CustomViews::Criteria] An instance of CustomViews::Criteria
+      # The method to set the value to deal_rule_criteria
+      # @param deal_rule_criteria [CustomViews::Criteria] An instance of CustomViews::Criteria
 
-    def criteria=(criteria)
-      if criteria!=nil and !criteria.is_a? CustomViews::Criteria
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', nil, nil)
+    def deal_rule_criteria=(deal_rule_criteria)
+      if deal_rule_criteria!=nil and !deal_rule_criteria.is_a? CustomViews::Criteria
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: deal_rule_criteria EXPECTED TYPE: Criteria', nil, nil)
       end
-      @criteria = criteria
-      @key_modified['criteria'] = 1
+      @deal_rule_criteria = deal_rule_criteria
+      @key_modified['deal_rule_criteria'] = 1
     end
 
       # The method to get the name
@@ -201,6 +203,42 @@ module Territories
       @key_modified['created_by'] = 1
     end
 
+      # The method to get the reporting_to
+      # @return An instance of Territory
+
+    def reporting_to
+      @reporting_to
+    end
+
+      # The method to set the value to reporting_to
+      # @param reporting_to [Territory] An instance of Territory
+
+    def reporting_to=(reporting_to)
+      if reporting_to!=nil and !reporting_to.is_a? Territory
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: reporting_to EXPECTED TYPE: Territory', nil, nil)
+      end
+      @reporting_to = reporting_to
+      @key_modified['reporting_to'] = 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

data/src/com/zoho/crm/api/users/users_operations.rb

@@ -28,7 +28,7 @@ module Users
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/users'
+      api_path = api_path + '/crm/v2.1/users'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET
       handler_instance.category_method = 'READ'
@@ -48,7 +48,7 @@ module Users
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/users'
+      api_path = api_path + '/crm/v2.1/users'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_POST
       handler_instance.category_method = 'CREATE'
@@ -69,7 +69,7 @@ module Users
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/users'
+      api_path = api_path + '/crm/v2.1/users'
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_PUT
       handler_instance.category_method = 'UPDATE'
@@ -94,7 +94,7 @@ module Users
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/users/'
+      api_path = api_path + '/crm/v2.1/users/'
       api_path = api_path + id.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_GET
@@ -118,7 +118,7 @@ module Users
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/users/'
+      api_path = api_path + '/crm/v2.1/users/'
       api_path = api_path + id.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_PUT
@@ -139,7 +139,7 @@ module Users
       end
       handler_instance = Handler::CommonAPIHandler.new
       api_path = ''
-      api_path = api_path + '/crm/v2/users/'
+      api_path = api_path + '/crm/v2.1/users/'
       api_path = api_path + id.to_s
       handler_instance.api_path = api_path
       handler_instance.http_method = Constants::REQUEST_METHOD_DELETE

data/src/com/zoho/crm/api/util/api_http_connector.rb

@@ -24,7 +24,7 @@ module Util
     end
 
     def set_content_type_header
-      Constants::SET_TO_CONTENT_TYPE.each do |content_type|
+      Constants::SET_CONTENT_TYPE_HEADER.each do |content_type|
         if @url.include? content_type
           @headers[Constants::CONTENT_TYPE] = @content_type
           break
@@ -101,11 +101,12 @@ module Util
     end
 
     def proxy_log(request_proxy)
+      proxy_log = Constants::PROXY_SETTINGS + Constants::PROXY_HOST + request_proxy.host + " , "
+      proxy_log += Constants::PROXY_PORT + request_proxy.port.to_s
       if request_proxy.user_name.nil?
-        'Proxy settings - Host : ' + request_proxy.host + ' , Port : ' + request_proxy.port.to_s
-      else
-        'Proxy settings - Host : ' + request_proxy.host + ' , Port : ' + request_proxy.port.to_s + ' , Proxy User : ' + request_proxy.user_name
+        proxy_log +=  " , " + Constants::PROXY_USER + request_proxy.user_name
       end
+      proxy_log
     end
   end
 end

data/src/com/zoho/crm/api/util/constants.rb

@@ -26,6 +26,8 @@ class Constants
 
   RESPONSECODE_BAD_REQUEST = 400
 
+  JSON_DETAILS_ERROR = "ERROR IN READING JSONDETAILS FILE"
+
   RESPONSECODE_AUTHORIZATION_ERROR = 401
 
   RESPONSECODE_FORBIDDEN = 403
@@ -94,15 +96,81 @@ class Constants
 
   HTTP = 'http'
 
+  KEY_VS_INVENTORY_MODULE = {
+    "Quoted_Items"=>"quotes",
+
+    "Invoiced_Items" => "invoices",
+
+    "Purchase_Items" => "purchase_orders",
+
+    "Ordered_Items" => "sales_orders"
+
+  }
+  DEFAULT_MODULENAME_VS_APINAME = {
+
+    "leads" => "Leads",
+
+    "contacts" => "Contacts",
+
+    "accounts" => "Accounts",
+
+    "deals" => "Deals",
+
+    "tasks" => "Tasks",
+
+    "events" => "Events",
+
+    "activities" => "Activities",
+
+    "calls" => "Calls",
+
+    "products" => "Products",
+
+    "quotes" => "Quotes",
+
+    "sales_orders" => "Sales_Orders",
+
+    "purchase_orders" => "Purchase_Orders",
+
+    "invoices" => "Invoices",
+
+    "campaigns" => "Campaigns",
+
+    "vendors" => "Vendors",
+
+    "price_books" => "Price_Books",
+
+    "cases" => "Cases",
+
+    "solutions" => "Solutions",
+
+    "visits" => "Visits",
+
+    "approvals" => "Approvals",
+
+    "notes" => "Notes",
+
+    "attachments" => "Attachments",
+
+    "actions_performed" => "Actions_Performed",
+
+}
+
+  USER_AGENT = "Mozilla/5.0"
+  
+  USER_AGENT_KEY = "user-agent"
+
   CONTENT_API_URL = 'content.zohoapis.com'
 
   INVALID_URL_ERROR = 'Invalid URI Error'
 
   ZOHO_SDK = 'X-ZOHO-SDK'
 
-  SDK_VERSION = '2.0.0'
+  SDK_VERSION = '3.0.0-beta'
 
-  SET_TO_CONTENT_TYPE = ['/crm/bulk/v2/read', '/crm/bulk/v2/write']
+  SET_CONTENT_TYPE_HEADER = ['/crm/bulk/v2.1/read', '/crm/bulk/v2.1/write']
+
+  RESOURCE_PATH_INVALID_ERROR_MESSAGE = "Resource Path MUST be a valid directory."
 
   IS_GENERATE_REQUEST_BODY =[REQUEST_METHOD_POST,REQUEST_METHOD_PUT,REQUEST_METHOD_PATCH]
 
@@ -112,9 +180,9 @@ class Constants
     
   CRM = "crm"
   
-  API_VERSION = "v2"
+  API_VERSION = "v2.1"
 
-  PHOTO_SUPPORTED_MODULES = ["leads", "contacts", "accounts", "products", "vendors"]
+  PHOTO_SUPPORTED_MODULES = ["Leads", "Contacts", "Accounts", "Products", "Vendors", "Deals", "Cases", "Solutions"]
 
   PARAMETER_NULL_ERROR = 'NULL PARAMETER ERROR'
 
@@ -168,6 +236,16 @@ class Constants
 
   EXPIRY_TIME = 'expiry_time'
 
+  PROXY_SETTINGS = "Proxy settings - "
+	
+	PROXY_HOST = "Host: "
+	
+	PROXY_PORT = "Port: "
+	
+	PROXY_USER = "User: "
+	
+	PROXY_DOMAIN = "Domain: "
+
   USER_MAIL_NULL_ERROR = 'USER MAIL NULL ERROR'
 
   USER_MAIL_NULL_ERROR_MESSAGE = 'User Mail MUST NOT be null. Use setUserMail() to set value.'
@@ -178,6 +256,10 @@ class Constants
 
   GET_TOKEN_DB_ERROR = 'Exception in get_token - DBStore:'
 
+  GET_TOKEN_BY_ID_DB_ERROR = "Exception in getTokenById - DBStore : Given ID is invalid"
+
+  GET_TOKEN_BY_ID_FILE_ERROR = "Exception in getTokenById - FileStore : Given ID is invalid"
+
   GET_TOKENS_DB_ERROR = 'Exception in get_tokens - DBStore:'
 
   DELETE_TOKEN_DB_ERROR = 'Exception in delete_token - DBStore:'
@@ -188,6 +270,8 @@ class Constants
 
   GET_TOKEN_FILE_ERROR = 'Exception in get_token - FileStore:'
 
+  LOGGER_INITIALIZATION_ERROR = "Exception in Logger Initialization : "
+
   REFRESH_SINGLE_MODULE_FIELDS_ERROR = 'Exception in refreshing fields of module : '
 
   REFRESH_ALL_MODULE_FIELDS_ERROR = 'Exception in refreshing fields of all modules : '
@@ -214,8 +298,6 @@ class Constants
 
   DELETE_TOKENS_FILE_ERROR = 'Exception in delete_tokens - FileStore:'
 
-  SDK_LOGGER_INITIALIZE = 'Exception in Logger Initialization'
-
   DELETE_MODULE_FROM_FIELDFILE_ERROR = 'Exception in deleting module from Fields file'
 
   DELETE_FIELD_FILE_ERROR = 'Exception in deleting Current User Fields file'
@@ -230,7 +312,25 @@ class Constants
 
   GIVEN_VALUE = "given-value"
 
-  PHOTO_UPLOAD_ERROR_MESSAGE  = "The given module is not supported in API.";
+  MULTI_SELECT_LOOKUP = "multiselectlookup"
+
+  MULTI_USER_LOOKUP = "multiuserlookup"
+
+  TERRITORIES = "territories"
+
+  GENERATED_TYPE = "generated_type"
+
+  GENERATED_TYPE_CUSTOM = "custom"
+
+  UPLOAD_PHOTO_UNSUPPORTED_MESSAGE = "Photo Upload Operation is not supported by the module: "
+
+  SDK_MODULE_METADATA = "SDK-MODULE-METADATA"
+
+  INVALID_MODULE_API_NAME_ERROR = "INVALID MODULE API NAME ERROR"
+
+  PROVIDE_VALID_MODULE_API_NAME = "PROVIDE VALID MODULE API NAME: "
+
+  UPLOAD_PHOTO_UNSUPPORTED_ERROR = "UPLOAD PHOTO UNSUPPORTED MODULE"
     
   INVALID_MODULE  = "INVALID_MODULE"
 
@@ -261,6 +361,8 @@ class Constants
   REQUEST_CATEGORY_UPDATE = 'UPDATE'
 
   MODULEPACKAGENAME = 'modulePackageName'
+  
+  MYSQL_TABLE_NAME = "oauthtoken"
 
   INITIALIZATION_SUCCESSFUL = 'Initialization successful'
 
@@ -493,19 +595,23 @@ class Constants
   HOST_ERROR_MESSAGE = 'Host MUST NOT be null.'
 
   PORT_ERROR_MESSAGE = 'Port MUST NOT be null.'
+
+  REQUEST_PROXY_ERROR_MESSAGE = "request_proxy must be instance of Request Proxy"
+  
+  USER_SIGNATURE_ERROR_MESSAGE = "user must be instance of UserSignature."
 	
-	USERSIGNATURE_ERROR_MESSAGE = "UserSignature MUST NOT be null."
-	
-	ENVIRONMENT_ERROR_MESSAGE = "Environment MUST NOT be null."
+  ENVIRONMENT_ERROR_MESSAGE = "environment must be instance of Environment."
 	
-	SDK_CONFIG_ERROR_MESSAGE = "sdkConfig MUST NOT be null."
+  SDK_CONFIG_ERROR_MESSAGE = "sdk_config must be instance of sdkConfig."
 
-  TOKEN_ERROR_MESSAGE = "Token MUST NOT be null."
+  TOKEN_ERROR_MESSAGE = "token must be instance of Token."
 	
-	STORE_ERROR_MESSAGE = "Store MUST NOT be null."
+  STORE_ERROR_MESSAGE = "store must be instance of Store."
 
   INITIALIZATION_EXCEPTION = 'Exception in initialization'
 
+  SWITCH_USER_EXCEPTION = 'Exception in Switch user'
+  
   SWITCH_USER_ERROR = "SWITCH USER ERROR"
 
   EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i
@@ -528,9 +634,30 @@ class Constants
 
   ATTACHMENTS = '$attachments'
 
+  TERRITORY_NAMESPACE = 'com.zoho.crm.api.record.Territory'
+
+  IMAGEUPLOAD_NAMESPACE = 'com.zoho.crm.api.record.ImageUpload'
+
   ATTACHMENTS_NAMESPACE = 'com.zoho.crm.api.attachments.Attachment'
 
   PICKLIST = 'picklist'
 
   CONSENT_NAMESPACE = 'com.zoho.crm.api.record.Consent'
+
+  INVALID_TOKEN_ERROR = "INVALID TOKEN ERROR"
+
+  NO_ACCESS_TOKEN_ERROR = "ACCESS TOKEN IS NOT PRESENT IN RESPONSE"
+
+  CLIENT_ID_NULL_ERROR_MESSAGE = "ClientID MUST NOT be null"
+
+  CLIENT_SECRET_NULL_ERROR_MESSAGE = "ClientSecret MUST NOT be null"
+
+  TAX_NAMESPACE = "com.zoho.crm.api.record.Tax"
+
+  PRODUCTS = "Products"
+
+  TAX = "TAX"
+
+  TERRITORY = "Territory"
+
 end