ZCRMSDK 0.0.2

data/lib/ZCRMSDK/org.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require_relative 'handler'
+require_relative 'utility'
+require_relative 'operations'
+module ZCRMSDK
+  module Org
+    # THIS CLASS IS USED TO STORE AND EXECUTE ORGANIZATION RELATED FUNCTIONALITIES
+    class ZCRMOrganization
+      attr_accessor :users_license_purchased, :photo_id, :privacy_settings, :zia_portal_id, :currency, :company_name, :org_id, :alias_aka, :primary_zuid, :zgid, :primary_email, :website, :mobile, :phone, :employee_count, :description, :time_zone, :iso_code, :currency_locale, :currency_symbol, :street, :state, :city, :country, :zip_code, :country_code, :fax, :mc_status, :is_gapps_enabled, :paid_expiry, :trial_type, :trial_expiry, :is_paid_account, :paid_type
+      def initialize(org_name = nil, org_id = nil)
+        @currency = nil
+        @zia_portal_id = nil
+        @privacy_settings = nil
+        @photo_id = nil
+        @company_name = org_name
+        @org_id = org_id
+        @alias_aka = nil
+        @primary_zuid = nil
+        @zgid = nil
+        @primary_email = nil
+        @website = nil
+        @mobile = nil
+        @phone = nil
+        @employee_count = nil
+        @description = nil
+        @time_zone = nil
+        @iso_code = nil
+        @currency_locale = nil
+        @currency_symbol = nil
+        @street = nil
+        @state = nil
+        @city = nil
+        @country = nil
+        @zip_code = nil
+        @country_code = nil
+        @fax = nil
+        @mc_status = nil
+        @is_gapps_enabled = nil
+        @paid_expiry = nil
+        @trial_type = nil
+        @trial_expiry = nil
+        @is_paid_account = nil
+        @paid_type = nil
+        @users_license_purchased = nil
+      end
+
+      def self.get_instance(org_name = nil, org_id = nil)
+        ZCRMOrganization.new(org_name, org_id)
+      end
+
+      def get_user(user_id)
+        Handler::OrganizationAPIHandler.get_instance.get_user(user_id)
+      end
+
+      def get_current_user
+        Handler::OrganizationAPIHandler.get_instance.get_current_user
+      end
+
+      def get_all_users
+        Handler::OrganizationAPIHandler.get_instance.get_all_users
+      end
+
+      def get_all_active_users
+        Handler::OrganizationAPIHandler.get_instance.get_all_active_users
+      end
+
+      def get_all_deactive_users
+        Handler::OrganizationAPIHandler.get_instance.get_all_deactive_users
+      end
+
+      def get_all_confirmed_users
+        Handler::OrganizationAPIHandler.get_instance.get_all_confirmed_users
+      end
+
+      def get_all_not_confirmed_users
+        Handler::OrganizationAPIHandler.get_instance.get_all_not_confirmed_users
+      end
+
+      def get_all_deleted_users
+        Handler::OrganizationAPIHandler.get_instance.get_all_deleted_users
+      end
+
+      def get_all_active_confirmed_users
+        Handler::OrganizationAPIHandler.get_instance.get_all_active_confirmed_users
+      end
+
+      def get_all_admin_users
+        Handler::OrganizationAPIHandler.get_instance.get_all_admin_users
+      end
+
+      def get_all_active_confirmed_admin_users
+        Handler::OrganizationAPIHandler.get_instance.get_all_active_confirmed_admin_users
+      end
+
+      def get_all_profiles
+        Handler::OrganizationAPIHandler.get_instance.get_all_profiles
+      end
+
+      def get_profile(profile_id)
+        Handler::OrganizationAPIHandler.get_instance.get_profile(profile_id)
+      end
+
+      def get_all_roles
+        Handler::OrganizationAPIHandler.get_instance.get_all_roles
+      end
+
+      def get_role(role_id)
+        Handler::OrganizationAPIHandler.get_instance.get_role(role_id)
+      end
+
+      def create_user(user_instance)
+        Handler::OrganizationAPIHandler.get_instance.create_user(user_instance)
+      end
+
+      def update_user(user_instance)
+        Handler::OrganizationAPIHandler.get_instance.update_user(user_instance)
+      end
+
+      def delete_user(user_id)
+        Handler::OrganizationAPIHandler.get_instance.delete_user(user_id)
+      end
+
+      def get_organization_taxes
+        Handler::OrganizationAPIHandler.get_instance.get_organization_taxes
+      end
+
+      def get_organization_tax(org_tax_id)
+        Handler::OrganizationAPIHandler.get_instance.get_organization_tax(org_tax_id)
+      end
+
+      def search_users_by_criteria(criteria, type = nil)
+        Handler::OrganizationAPIHandler.get_instance.search_users_by_criteria(criteria, type)
+      end
+
+      def create_organization_taxes(orgtax_instances)
+        Handler::OrganizationAPIHandler.get_instance.create_organization_taxes(orgtax_instances)
+      end
+
+      def update_organization_taxes(orgtax_instances)
+        Handler::OrganizationAPIHandler.get_instance.update_organization_taxes(orgtax_instances)
+      end
+
+      def delete_organization_taxes(orgtax_ids)
+        Handler::OrganizationAPIHandler.get_instance.delete_organization_taxes(orgtax_ids)
+      end
+
+      def delete_organization_tax(orgtax_id)
+        Handler::OrganizationAPIHandler.get_instance.delete_organization_tax(orgtax_id)
+      end
+    end
+  end
+end

data/lib/ZCRMSDK/persistence.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative 'oauth_utility'
+require_relative 'oauth_client'
+module ZCRMSDK
+  module Persistence
+    # THIS CLASS IS USED TO STORE, RETRIEVE, DELETE TOKENS IN DEFAULT DB
+    class ZohoOAuthPersistenceHandler
+      def initialize; end
+
+      def self.get_instance
+        ZohoOAuthPersistenceHandler.new
+      end
+
+      def save_oauth_tokens(oauth_tokens)
+        delete_oauth_tokens(oauth_tokens.user_identifier)
+        con = Mysql2::Client.new(host: $OAUTH_CONFIG_PROPERTIES['db_address'], username: $OAUTH_CONFIG_PROPERTIES['db_username'], password: $OAUTH_CONFIG_PROPERTIES['db_password'], database: 'zohooauth', port: $OAUTH_CONFIG_PROPERTIES['db_port'])
+        con.query("insert into oauthtokens(useridentifier,accesstoken,refreshtoken,expirytime) values('#{oauth_tokens.user_identifier}','#{oauth_tokens.access_token}','#{oauth_tokens.refresh_token}',#{oauth_tokens.expiry_time})")
+        con.close
+      rescue Mysql2::Error => e
+        Utility::SDKLogger.add_log(e.error, OAuthUtility::ZohoOAuthConstants::ERROR, e)
+      ensure
+        con.close
+      end
+
+      def get_oauth_tokens(user_identifier)
+        con = Mysql2::Client.new(host: $OAUTH_CONFIG_PROPERTIES['db_address'], username: $OAUTH_CONFIG_PROPERTIES['db_username'], password: $OAUTH_CONFIG_PROPERTIES['db_password'], database: 'zohooauth', port: $OAUTH_CONFIG_PROPERTIES['db_port'])
+        query = "select * from oauthtokens where useridentifier='#{user_identifier}'"
+        rs = con.query(query)
+        oauth_tokens = nil
+        rs.each do |row|
+          oauth_tokens = OAuthClient::ZohoOAuthTokens.get_instance(row['refreshtoken'], row['accesstoken'], row['expirytime'], user_identifier)
+          con.close
+          return oauth_tokens
+        end
+        raise OAuthUtility::ZohoOAuthException.get_instance('get_oauth_tokens', 'no such email id - ' + user_identifier + ' present in the DB', 'Exception occured while fetching accesstoken from Grant Token', OAuthUtility::ZohoOAuthConstants::ERROR)
+      rescue Mysql2::Error => e
+        Utility::SDKLogger.add_log(e.error, OAuthUtility::ZohoOAuthConstants::ERROR, e)
+      ensure
+        con.close
+      end
+
+      def delete_oauth_tokens(user_identifier)
+        con = Mysql2::Client.new(host: $OAUTH_CONFIG_PROPERTIES['db_address'], username: $OAUTH_CONFIG_PROPERTIES['db_username'], password: $OAUTH_CONFIG_PROPERTIES['db_password'], database: 'zohooauth', port: $OAUTH_CONFIG_PROPERTIES['db_port'])
+        delete_query = "delete from oauthtokens where useridentifier='#{user_identifier}'"
+        con.query(delete_query)
+        con.close
+      rescue Mysql2::Error => e
+        Utility::SDKLogger.add_log(e.error, OAuthUtility::ZohoOAuthConstants::ERROR, e)
+      ensure
+        con.close
+      end
+    end
+    # THIS CLASS IS USED TO STORE, RETRIEVE, DELETE TOKENS IN FILE
+    class ZohoOAuthFilePersistenceHandler
+      def initialize; end
+
+      def self.get_instance
+        ZohoOAuthFilePersistenceHandler.new
+      end
+
+      def save_oauth_tokens(oauth_tokens)
+        unless File.exist?($OAUTH_CONFIG_PROPERTIES[OAuthUtility::ZohoOAuthConstants::TOKEN_PERSISTENCE_PATH].dup + '/zcrm_oauthtokens.txt')
+          file_obj = File.new($OAUTH_CONFIG_PROPERTIES[OAuthUtility::ZohoOAuthConstants::TOKEN_PERSISTENCE_PATH].dup + '/zcrm_oauthtokens.txt', 'w')
+          file_obj.close
+        end
+        delete_oauth_tokens(oauth_tokens.user_identifier)
+        arr = []
+        path = $OAUTH_CONFIG_PROPERTIES[OAuthUtility::ZohoOAuthConstants::TOKEN_PERSISTENCE_PATH].dup + '/zcrm_oauthtokens.txt'
+        file_obj = File.open(path, 'r')
+        serialized = file_obj.read
+        file_obj.close
+        arr = Marshal.load(serialized) unless serialized.nil? || serialized.empty?
+        arr.push(oauth_tokens)
+        file_obj = File.open(path, 'w+')
+        file_obj.write(Marshal.dump(arr))
+        file_obj.close
+      end
+
+      def get_oauth_tokens(user_identifier)
+        if !File.exist?($OAUTH_CONFIG_PROPERTIES[OAuthUtility::ZohoOAuthConstants::TOKEN_PERSISTENCE_PATH].dup + '/zcrm_oauthtokens.txt')
+          raise OAuthUtility::ZohoOAuthException.get_instance('get_oauth_tokens', 'file does not exist!generate the access token!', 'Error occured while getting access token', OAuthUtility::ZohoOAuthConstants::ERROR)
+        end
+
+        path = $OAUTH_CONFIG_PROPERTIES[OAuthUtility::ZohoOAuthConstants::TOKEN_PERSISTENCE_PATH].dup + '/zcrm_oauthtokens.txt'
+        file_obj = File.open(path, 'r')
+        serialized = file_obj.read
+        file_obj.close
+        if serialized.empty? || serialized.nil?
+          raise OAuthUtility::ZohoOAuthException.get_instance('get_oauth_tokens', 'no tokens found!generate the access token!', 'Error occured while getting access token', OAuthUtility::ZohoOAuthConstants::ERROR)
+        end
+
+        deserialized = Marshal.load(serialized)
+        deserialized.each do |token|
+          return token if token.user_identifier == user_identifier
+        end
+        raise OAuthUtility::ZohoOAuthException.get_instance('get_oauth_tokens', 'no such' + user_identifier.to_s + 'present in the File', 'Exception occured while fetching accesstoken from Grant Token', OAuthUtility::ZohoOAuthConstants::ERROR)
+      end
+
+      def delete_oauth_tokens(user_identifier)
+        path = $OAUTH_CONFIG_PROPERTIES[OAuthUtility::ZohoOAuthConstants::TOKEN_PERSISTENCE_PATH].dup + '/zcrm_oauthtokens.txt'
+        file_obj = File.open(path, 'r')
+        serialized = file_obj.read
+        file_obj.close
+
+        return if serialized.empty? || serialized.nil?
+
+        found = false
+        i = 0
+        deserialized = Marshal.load(serialized)
+        deserialized.each do |token|
+          if token.user_identifier == user_identifier
+            found = true
+            break
+          end
+          i += 1
+        end
+        if found
+          deserialized.delete_at(i)
+          file_obj = File.open(path, 'w+')
+          file_obj.write(Marshal.dump(deserialized))
+          file_obj.close
+        end
+      end
+    end
+  end
+end

data/lib/ZCRMSDK/request.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative 'utility'
+require_relative 'response'
+module ZCRMSDK
+  module Request
+    # THIS CLASS IS USED TO AUTHENTICATE AND CONSTRUCT API REQUEST
+    class APIRequest
+      def initialize(api_handler_ins)
+        construct_api_url
+        @url += api_handler_ins.request_url_path
+        @url = 'https://' + @url unless @url.start_with?('http')
+        @request_body = api_handler_ins.request_body
+        @request_headers = api_handler_ins.request_headers
+        @request_params = api_handler_ins.request_params
+        @request_method = api_handler_ins.request_method
+        @request_api_key = api_handler_ins.request_api_key
+      end
+
+      def self.get_instance(api_handler_ins)
+        APIRequest.new(api_handler_ins)
+      end
+
+      def construct_api_url
+        hit_sandbox = ZCRMSDK::Utility::ZCRMConfigUtil.get_config_value(ZCRMSDK::Utility::APIConstants::SANDBOX)
+        url = ZCRMSDK::Utility::ZCRMConfigUtil.get_api_base_url
+        if hit_sandbox == 'true'
+          url = url.sub('www.', 'sandbox.')
+        end
+        @url = url + '/crm/' + ZCRMSDK::Utility::ZCRMConfigUtil.get_api_version + '/'
+      end
+
+      def authenticate_request
+        access_token = ZCRMSDK::Utility::ZCRMConfigUtil.get_instance.get_access_token
+        if @request_headers.nil?
+          @request_headers = { ZCRMSDK::Utility::APIConstants::AUTHORIZATION => ZCRMSDK::Utility::APIConstants::OAUTH_HEADER_PREFIX.dup + access_token }
+        else
+          @request_headers[ZCRMSDK::Utility::APIConstants::AUTHORIZATION] = ZCRMSDK::Utility::APIConstants::OAUTH_HEADER_PREFIX.dup + access_token
+        end
+        @request_headers['User-Agent'] = 'ZohoCRM Ruby SDK'
+      end
+
+      def get_api_response
+        authenticate_request
+        connector = ZCRMSDK::Utility::ZohoHTTPConnector.get_instance(@url, @request_params, @request_headers, @request_body.to_json, @request_method, @request_api_key, false)
+        response = connector.trigger_request
+        Response::APIResponse.get_instance(response, response.code.to_i, @url, @request_api_key)
+      end
+
+      def get_bulk_api_response
+        authenticate_request
+        connector = ZCRMSDK::Utility::ZohoHTTPConnector.get_instance(@url, @request_params, @request_headers, @request_body.to_json, @request_method, @request_api_key, true)
+        response = connector.trigger_request
+        Response::BulkAPIResponse.get_instance(response, response.code.to_i, @url, @request_api_key)
+      end
+
+      def upload_file(file_path)
+        authenticate_request
+        form_data = [['file', File.open(file_path)]]
+        connector = ZCRMSDK::Utility::ZohoHTTPConnector.get_instance(@url, @request_params, @request_headers, @request_body, @request_method, @request_api_key, false, form_data)
+        response = connector.trigger_request
+        Response::APIResponse.get_instance(response, response.code.to_i, @url, @request_api_key)
+      end
+
+      def upload_link_as_attachment(link_url)
+        authenticate_request
+        form_data = [['attachmentUrl', link_url]]
+        connector = ZCRMSDK::Utility::ZohoHTTPConnector.get_instance(@url, @request_params, @request_headers, @request_body, @request_method, @request_api_key, false, form_data)
+        response = connector.trigger_request
+        Response::APIResponse.get_instance(response, response.code.to_i, @url, @request_api_key)
+      end
+
+      def download_file
+        authenticate_request
+        connector = ZCRMSDK::Utility::ZohoHTTPConnector.get_instance(@url, @request_params, @request_headers, @request_body, @request_method, @request_api_key, false)
+        response = connector.trigger_request
+        file_response = Response::FileAPIResponse.get_instance(response, response.code.to_i, @url)
+        file_response.set_file_content
+        file_response
+      end
+    end
+  end
+end

data/lib/ZCRMSDK/response.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require_relative 'utility'
+require 'json'
+module ZCRMSDK
+  module Response
+    # THIS CLASS IS USED TO STORE DETAILS ABOUT THE API RESPONSE , PROCESS JSON AND HANDLE FAULTY RESPONSES
+    class CommonAPIResponse
+      attr_accessor :response_json, :response_headers, :response, :status_code, :api_key, :url, :data, :status, :code, :message, :details
+      def initialize(response, status_code, url, api_key = nil)
+        @response_json = nil
+        @response_headers = nil
+        @response = response
+        @status_code = status_code
+        @api_key = api_key
+        @url = url
+        @data = nil
+        @status = nil
+        @code = nil
+        @message = nil
+        @details = nil
+        set_response_json
+        process_response
+      end
+
+      def self.get_instance(response, status_code, url, api_key = nil)
+        CommonAPIResponse.new(response, status_code, url, api_key)
+      end
+
+      def set_response_json
+        if (@status_code != Utility::APIConstants::RESPONSECODE_NO_CONTENT) && (@status_code != Utility::APIConstants::RESPONSECODE_NOT_MODIFIED)
+          @response_json = JSON.parse(@response.body)
+        else
+          @response_json = {}
+          @response_headers = {}
+          return
+        end
+        @response_headers = @response.to_hash
+      end
+
+      def process_response
+        if Utility::APIConstants::FAULTY_RESPONSE_CODES.include?(@status_code)
+          handle_faulty_responses
+        elsif (@status_code == Utility::APIConstants::RESPONSECODE_ACCEPTED) || (@status_code == Utility::APIConstants::RESPONSECODE_OK) || (@status_code == Utility::APIConstants::RESPONSECODE_CREATED)
+          process_response_data
+        end
+      end
+
+      def handle_faulty_responses
+        nil
+      end
+
+      def process_response_data
+        nil
+      end
+    end
+    # THIS CLASS IS USED TO HANDLE API RESPONSE
+    class APIResponse < CommonAPIResponse
+      def initialize(response, status_code, url, api_key)
+        super
+      end
+
+      def self.get_instance(response, status_code, url, api_key)
+        APIResponse.new(response, status_code, url, api_key)
+      end
+
+      def handle_faulty_responses
+        if @status_code == Utility::APIConstants::RESPONSECODE_NO_CONTENT
+          error_msg = Utility::APIConstants::NO_CONTENT
+          exception = Utility::ZCRMException.get_instance(@url, @status_code, error_msg, Utility::APIConstants::NO_CONTENT, nil, error_msg)
+        else
+          response_json = @response_json
+          exception = Utility::ZCRMException.get_instance(@url, @status_code, response_json[Utility::APIConstants::MESSAGE], response_json[Utility::APIConstants::CODE], response_json[Utility::APIConstants::DETAILS], response_json[Utility::APIConstants::MESSAGE])
+        end
+        raise exception
+      end
+
+      def process_response_data
+        resp_json = @response_json
+        if resp_json.include?(api_key)
+          resp_json = @response_json[api_key]
+          resp_json = resp_json[0] if resp_json.instance_of?(Array)
+        end
+        if resp_json.include?(Utility::APIConstants::STATUS) && (resp_json[Utility::APIConstants::STATUS] == Utility::APIConstants::STATUS_ERROR)
+          exception = Utility::ZCRMException.get_instance(@url, @status_code, resp_json[Utility::APIConstants::MESSAGE], resp_json[Utility::APIConstants::CODE], resp_json[Utility::APIConstants::DETAILS], resp_json[Utility::APIConstants::STATUS])
+          raise exception
+        elsif resp_json.include?(Utility::APIConstants::STATUS) && (resp_json[Utility::APIConstants::STATUS] == Utility::APIConstants::STATUS_SUCCESS)
+          @status = resp_json[Utility::APIConstants::STATUS]
+          @code = resp_json[Utility::APIConstants::CODE]
+          @message = resp_json[Utility::APIConstants::MESSAGE]
+          @details = resp_json[Utility::APIConstants::DETAILS]
+        end
+      end
+    end
+    # THIS CLASS IS USED TO BULK API RESPONSE
+    class BulkAPIResponse < CommonAPIResponse
+      attr_accessor :bulk_entity_response, :info
+      def initialize(response, status_code, url, api_key)
+        @bulk_entity_response = []
+        super
+        if @response_json.include?(Utility::APIConstants::INFO)
+          @info = ResponseInfo.get_instance(@response_json[Utility::APIConstants::INFO])
+        end
+      end
+
+      def self.get_instance(response, status_code, url, api_key)
+        BulkAPIResponse.new(response, status_code, url, api_key)
+      end
+
+      def handle_faulty_responses
+        if @status_code == Utility::APIConstants::RESPONSECODE_NO_CONTENT
+          error_msg = Utility::APIConstants::NO_CONTENT
+          exception = Utility::ZCRMException.get_instance(@url, @status_code, error_msg, Utility::APIConstants::NO_CONTENT, nil, error_msg)
+        else
+          response_json = @response_json
+          exception = Utility::ZCRMException.get_instance(@url, @status_code, response_json[Utility::APIConstants::MESSAGE], response_json[Utility::APIConstants::CODE], response_json[Utility::APIConstants::DETAILS], response_json[Utility::APIConstants::MESSAGE])
+        end
+        raise exception
+      end
+
+      def process_response_data
+        responses_json = @response_json
+        if responses_json.include?(@api_key)
+          records_data = @response_json[api_key]
+          records_data.each do |record_data|
+            if !record_data.nil? && record_data.key?(Utility::APIConstants::STATUS)
+              @bulk_entity_response.push(EntityResponse.get_instance(record_data))
+            end
+          end
+        end
+      end
+    end
+    # THIS CLASS IS USED TO HANDLE FILE API RESPONSE
+    class FileAPIResponse
+      attr_accessor :filename, :response_json, :response_headers, :response, :status_code, :url, :data, :status, :code, :message, :details
+      def initialize(response, status_code, url)
+        @response_json = nil
+        @response_headers = nil
+        @response = response
+        @status_code = status_code
+        @url = url
+        @data = nil
+        @status = nil
+        @code = nil
+        @message = nil
+        @details = nil
+        @filename = nil
+      end
+
+      def self.get_instance(response, status_code, url)
+        FileAPIResponse.new(response, status_code, url)
+      end
+
+      def set_file_content
+        if @status_code == Utility::APIConstants::RESPONSECODE_NO_CONTENT
+          error_msg = Utility::APIConstants::NO_CONTENT
+          exception = Utility::ZCRMException.get_instance(@url, @status_code, error_msg, Utility::APIConstants::NO_CONTENT, nil, error_msg)
+          raise exception
+        end
+        if Utility::APIConstants::FAULTY_RESPONSE_CODES.include?(@status_code)
+          content = JSON.parse(@response.body)
+          exception = Utility::ZCRMException.get_instance(@url, @status_code, content[Utility::APIConstants::MESSAGE], content[Utility::APIConstants::CODE], content[Utility::APIConstants::DETAILS], content[Utility::APIConstants::MESSAGE])
+          raise exception
+        elsif @status_code == Utility::APIConstants::RESPONSECODE_OK
+          @response_headers = @response.to_hash
+          @status = Utility::APIConstants::STATUS_SUCCESS
+          @filename = @response_headers['content-disposition'][0]
+          @filename = @filename[@filename.rindex("'") + 1..@filename.length]
+          @response = @response.body
+        end
+        @response_headers = @response.to_hash if @response_headers.nil?
+      end
+    end
+    # THIS CLASS IS USED TO HANDLE ENTITY  API RESPONSE
+    class EntityResponse
+      attr_accessor :response_json, :code, :message, :status, :details, :data, :upsert_action, :upsert_duplicate_field
+      def initialize(entity_response)
+        @response_json = entity_response
+        @code = entity_response[Utility::APIConstants::CODE]
+        @message = entity_response[Utility::APIConstants::MESSAGE]
+        @status = entity_response[Utility::APIConstants::STATUS]
+        @details = nil
+        @data = nil
+        @upsert_action = nil
+        @upsert_duplicate_field = nil
+        if entity_response.key?(Utility::APIConstants::DETAILS)
+          @details = entity_response[Utility::APIConstants::DETAILS]
+        end
+        if entity_response.key?(Utility::APIConstants::ACTION)
+          @upsert_action = entity_response[Utility::APIConstants::ACTION]
+        end
+        if entity_response.key?(Utility::APIConstants::DUPLICATE_FIELD)
+          @upsert_duplicate_field = entity_response[Utility::APIConstants::DUPLICATE_FIELD]
+        end
+      end
+
+      def self.get_instance(entity_response)
+        EntityResponse.new(entity_response)
+      end
+    end
+    # THIS CLASS IS USED TO STORE RESPONSE INFO
+    class ResponseInfo
+      attr_reader :is_more_records, :page, :per_page, :count
+      def initialize(response_info_json)
+        @is_more_records = (response_info_json['more_records']) == true
+        @page = (response_info_json['page']).to_i
+        @per_page = (response_info_json['per_page']).to_i
+        @count = (response_info_json['count']).to_i
+      end
+
+      def self.get_instance(response_info_json)
+        ResponseInfo.new(response_info_json)
+      end
+    end
+  end
+end