netsuite-soap 2025.2.3

data/lib/netsuite/configuration.rb

@@ -0,0 +1,470 @@
+module NetSuite
+  module Configuration
+    extend self
+
+    def reset!
+      NetSuite::Utilities.clear_cache!
+
+      clear_wsdl_cache
+
+      attributes.clear
+    end
+
+    def attributes
+      if multi_tenant?
+        Thread.current[:netsuite_gem_attributes] ||= {}
+      else
+        @attributes ||= {}
+      end
+    end
+
+    def connection(params={}, credentials={}, soap_header_extra_info={})
+      client = Savon.client(savon_params(params, credentials, soap_header_extra_info))
+      cache_wsdl(client)
+      client
+    end
+
+    def savon_params(params={}, credentials={}, soap_header_extra_info={})
+      full_params = {
+        wsdl: cached_wsdl || wsdl,
+        endpoint: endpoint,
+        read_timeout: read_timeout,
+        open_timeout: open_timeout,
+        namespaces: namespaces,
+        soap_header: auth_header(credentials).update(soap_header).merge(soap_header_extra_info),
+        pretty_print_xml: true,
+        filters: filters,
+        logger: logger,
+        log_level: log_level,
+        log: !silent, # turn off logging entirely if configured
+        proxy: proxy,
+      }
+      full_params.update(params)
+      full_params.update(write_timeout: write_timeout) if supports_write_timeout?
+      full_params
+    end
+
+
+    def filters(list = nil)
+      if list
+        self.filters = list
+      else
+        attributes[:filters] ||= [
+          :password,
+          :email,
+          :consumerKey,
+          :token
+        ]
+      end
+    end
+
+    def filters=(list)
+      attributes[:filters] = list
+    end
+
+    def wsdl_cache
+      if multi_tenant?
+        Thread.current[:netsuite_gem_wsdl_cache] ||= {}
+      else
+        @wsdl_cache ||= {}
+      end
+    end
+
+    def clear_wsdl_cache
+      if multi_tenant?
+        Thread.current[:netsuite_gem_wsdl_cache] = {}
+      else
+        @wsdl_cache = {}
+      end
+    end
+
+    def cached_wsdl
+      cached = wsdl_cache.fetch(wsdl, nil)
+      if cached.is_a? String
+        cached
+      elsif cached.is_a? Savon::Client
+        wsdl_cache[wsdl] = cached.instance_eval { @wsdl.xml }
+      end
+    end
+
+    def cache_wsdl(client)
+      # NOTE the Savon::Client doesn't pull the wsdl content upon
+      # instantiation; it pulls it when it recieves the #call method.
+      # If we force it to pull the wsdl here, it will duplicate the call later.
+      # So, we stash the entire client and fetch just the wsdl from it after
+      # it completes its call
+      # For reference, see:
+      # https://github.com/savonrb/savon/blob/d64925d3add33fa5531577ce9e3a28a7a93618b1/lib/savon/client.rb#L35-L37
+      # https://github.com/savonrb/savon/blob/d64925d3add33fa5531577ce9e3a28a7a93618b1/lib/savon/operation.rb#L22
+      wsdl_cache[wsdl] ||= client
+    end
+
+    REQUIRED_API_VERSION = '2025_2'.freeze
+
+    def api_version(version = nil)
+      if version
+        self.api_version = version
+      else
+        attributes[:api_version] or
+          raise ConfigurationError, "api_version is not set. Add `api_version '#{REQUIRED_API_VERSION}'` to your NetSuite.configure block."
+      end
+    end
+
+    def api_version=(version)
+      unless version == REQUIRED_API_VERSION
+        raise ConfigurationError, "api_version must be '#{REQUIRED_API_VERSION}' — NetSuite SOAP 2025.2 is the final supported endpoint (removed 2028.2)."
+      end
+
+      if attributes[:api_version] != version
+        attributes[:wsdl] = nil
+        attributes[:wsdl_domain] = nil
+      end
+
+      attributes[:api_version] = version
+    end
+
+    def endpoint=(endpoint)
+      attributes[:endpoint] = endpoint
+    end
+
+    def endpoint(endpoint=nil)
+      if endpoint
+        self.endpoint = endpoint
+      else
+        attributes[:endpoint]
+      end
+    end
+
+    def sandbox=(flag)
+      if attributes[:sandbox] != flag
+        attributes[:wsdl] = nil
+        attributes[:wsdl_domain] = nil
+      end
+
+      attributes[:sandbox] = flag
+    end
+
+    def sandbox(flag = nil)
+      if flag.nil?
+        attributes[:sandbox] ||= false
+      else
+        self.sandbox = flag
+      end
+    end
+
+    def sandbox?
+      !!sandbox
+    end
+
+    def wsdl=(wsdl)
+      attributes[:wsdl] = wsdl
+    end
+
+    def wsdl(wsdl = nil)
+      if wsdl
+        self.wsdl = wsdl
+      else
+        attributes[:wsdl] ||= begin
+          if sandbox
+            "https://webservices.sandbox.netsuite.com/wsdl/v#{api_version}_0/netsuite.wsdl"
+          else
+            "https://#{wsdl_domain}/wsdl/v#{api_version}_0/netsuite.wsdl"
+          end
+        end
+      end
+    end
+
+    def wsdl_domain(wsdl_domain = nil)
+      if wsdl_domain
+        self.wsdl_domain = wsdl_domain
+      else
+        # if sandbox, this parameter is ignored
+        if sandbox
+          'webservices.sandbox.netsuite.com'
+        else
+          attributes[:wsdl_domain] ||= 'webservices.netsuite.com'
+        end
+      end
+    end
+
+    def wsdl_domain=(wsdl_domain)
+      if attributes[:wsdl_domain] != wsdl_domain
+        # reset full wsdl url to ensure it's regenerated with the updated `wsdl_domain` next time it's needed
+        attributes[:wsdl] = nil
+      end
+
+      attributes[:wsdl_domain] = wsdl_domain
+    end
+
+    def soap_header=(headers)
+      attributes[:soap_header] = headers
+    end
+
+    def soap_header(headers = nil)
+      if headers
+        self.soap_header = headers
+      else
+        attributes[:soap_header] ||= {}
+      end
+    end
+
+    def auth_header(credentials={})
+      if !credentials[:consumer_key].to_s.strip.empty? || !consumer_key.to_s.strip.empty?
+        token_auth(credentials)
+      else
+        user_auth(credentials)
+      end
+    end
+
+    def user_auth(credentials)
+      NetSuite::Passports::User.new(
+        credentials[:account] || account,
+        credentials[:email] || email,
+        credentials[:password] || password,
+        credentials[:role] || role
+      ).passport
+    end
+
+    def token_auth(credentials)
+      NetSuite::Passports::Token.new(
+        credentials[:account] || account,
+        credentials[:consumer_key] || consumer_key,
+        credentials[:consumer_secret] || consumer_secret,
+        credentials[:token_id] || token_id,
+        credentials[:token_secret] || token_secret
+      ).passport
+    end
+
+    def namespaces
+      {
+        'xmlns:platformMsgs'   => "urn:messages_#{api_version}.platform.webservices.netsuite.com",
+        'xmlns:platformCore'   => "urn:core_#{api_version}.platform.webservices.netsuite.com",
+        'xmlns:platformCommon' => "urn:common_#{api_version}.platform.webservices.netsuite.com",
+        'xmlns:listRel'        => "urn:relationships_#{api_version}.lists.webservices.netsuite.com",
+        'xmlns:tranSales'      => "urn:sales_#{api_version}.transactions.webservices.netsuite.com",
+        'xmlns:tranPurch'      => "urn:purchases_#{api_version}.transactions.webservices.netsuite.com",
+        'xmlns:actSched'       => "urn:scheduling_#{api_version}.activities.webservices.netsuite.com",
+        'xmlns:setupCustom'    => "urn:customization_#{api_version}.setup.webservices.netsuite.com",
+        'xmlns:listAcct'       => "urn:accounting_#{api_version}.lists.webservices.netsuite.com",
+        'xmlns:tranBank'       => "urn:bank_#{api_version}.transactions.webservices.netsuite.com",
+        'xmlns:tranCust'       => "urn:customers_#{api_version}.transactions.webservices.netsuite.com",
+        'xmlns:tranEmp'        => "urn:employees_#{api_version}.transactions.webservices.netsuite.com",
+        'xmlns:tranInvt'       => "urn:inventory_#{api_version}.transactions.webservices.netsuite.com",
+        'xmlns:listSupport'    => "urn:support_#{api_version}.lists.webservices.netsuite.com",
+        'xmlns:tranGeneral'    => "urn:general_#{api_version}.transactions.webservices.netsuite.com",
+        'xmlns:commGeneral'    => "urn:communication_#{api_version}.general.webservices.netsuite.com",
+        'xmlns:listMkt'        => "urn:marketing_#{api_version}.lists.webservices.netsuite.com",
+        'xmlns:listWebsite'    => "urn:website_#{api_version}.lists.webservices.netsuite.com",
+        'xmlns:fileCabinet'    => "urn:filecabinet_#{api_version}.documents.webservices.netsuite.com",
+        'xmlns:listEmp'        => "urn:employees_#{api_version}.lists.webservices.netsuite.com"
+      }
+    end
+
+    def role=(role)
+      attributes[:role] = role
+    end
+
+    def role(role = nil)
+      if role
+        self.role = role
+      else
+        attributes[:role] ||= '3'
+      end
+    end
+
+    def email=(email)
+      attributes[:email] = email
+    end
+
+    def email(email = nil)
+      if email
+        self.email = email
+      else
+        attributes[:email]
+      end
+    end
+
+    def password=(password)
+      attributes[:password] = password
+    end
+
+    def password(password = nil)
+      if password
+        self.password = password
+      else
+        attributes[:password]
+      end
+    end
+
+    def account=(account)
+      attributes[:account] = account
+    end
+
+    def account(account = nil)
+      if account
+        self.account = account
+      else
+        attributes[:account]
+      end
+    end
+
+    def consumer_key=(consumer_key)
+      attributes[:consumer_key] = consumer_key
+    end
+
+    def consumer_key(consumer_key = nil)
+      if consumer_key
+        self.consumer_key = consumer_key
+      else
+        attributes[:consumer_key]
+      end
+    end
+
+    def consumer_secret=(consumer_secret)
+      attributes[:consumer_secret] = consumer_secret
+    end
+
+    def consumer_secret(consumer_secret = nil)
+      if consumer_secret
+        self.consumer_secret = consumer_secret
+      else
+        attributes[:consumer_secret]
+      end
+    end
+
+    def token_id=(token_id)
+      attributes[:token_id] = token_id
+    end
+
+    def token_id(token_id = nil)
+      if token_id
+        self.token_id = token_id
+      else
+        attributes[:token_id]
+      end
+    end
+
+    def token_secret=(token_secret)
+      attributes[:token_secret] = token_secret
+    end
+
+    def token_secret(token_secret = nil)
+      if token_secret
+        self.token_secret = token_secret
+      else
+        attributes[:token_secret]
+      end
+    end
+
+    def read_timeout=(timeout)
+      attributes[:read_timeout] = timeout
+    end
+
+    def read_timeout(timeout = nil)
+      if timeout
+        self.read_timeout = timeout
+      else
+        attributes[:read_timeout] ||= 60
+      end
+    end
+
+    def open_timeout=(timeout)
+      attributes[:open_timeout] = timeout
+    end
+
+    def open_timeout(timeout = nil)
+      if timeout
+        self.open_timeout = timeout
+      else
+        attributes[:open_timeout]
+      end
+    end
+
+    def write_timeout=(timeout)
+      write_timeout_not_supported! unless supports_write_timeout?
+      attributes[:write_timeout] = timeout
+    end
+
+    def write_timeout(timeout = nil)
+      if timeout
+        write_timeout_not_supported! unless supports_write_timeout?
+        self.write_timeout = timeout
+      else
+        attributes[:write_timeout]
+      end
+    end
+
+    def log=(path)
+      attributes[:log] = path
+    end
+
+    def log(path = nil)
+      self.log = path if path
+      attributes[:log]
+    end
+
+    def logger(value = nil)
+      if value.nil?
+        # if passed a IO object (like StringIO) `empty?` won't exist
+        valid_log = log && !(log.respond_to?(:empty?) && log.empty?)
+
+        attributes[:logger] ||= ::Logger.new(valid_log ? log : $stdout)
+      else
+        attributes[:logger] = value
+      end
+    end
+
+    def logger=(value)
+      attributes[:logger] = value
+    end
+
+    def silent(value=nil)
+      self.silent = value if !value.nil?
+      attributes[:silent]
+    end
+
+    def silent=(value)
+      attributes[:silent] ||= value
+    end
+
+    def log_level(value = nil)
+      self.log_level = value if value
+
+      attributes[:log_level] || :debug
+    end
+
+    def log_level=(value)
+      attributes[:log_level] = value
+    end
+
+    def proxy=(proxy)
+      attributes[:proxy] = proxy
+    end
+
+    def proxy(proxy = nil)
+      if proxy
+        self.proxy = proxy
+      else
+        attributes[:proxy]
+      end
+    end
+
+    def multi_tenant!
+      @multi_tenant = true
+    end
+
+    def multi_tenant?
+      @multi_tenant
+    end
+
+    private
+
+    def supports_write_timeout?
+      Savon::VERSION >= "2.13.0"
+    end
+
+    def write_timeout_not_supported!
+      fail(ConfigurationError, "Savon doesn't support write_timeout until version 2.13.0")
+    end
+  end
+end

data/lib/netsuite/errors.rb

@@ -0,0 +1,18 @@
+module NetSuite
+  class RecordNotFound < StandardError; end
+  class InitializationError < StandardError; end
+  class ConfigurationError < StandardError; end
+
+  # NOTE not an exception, used as a wrapped around NetSuite SOAP error
+  class Error
+    attr_accessor :type, :code, :message
+
+    def initialize(args = {})
+      @type    = args[:@type]
+      @code    = args[:code]
+      @message = args[:message]
+    end
+
+    alias_method :to_s, :inspect
+  end
+end

data/lib/netsuite/namespaces/act_sched.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  	module Namespaces
+    	module ActSched
+
+    		def record_namespace
+        		'actSched'
+      		end
+      		
+    	end
+	end
+end

data/lib/netsuite/namespaces/comm_general.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module CommGeneral
+
+      def record_namespace
+        'commGeneral'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/file_cabinet.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module FileCabinet
+
+      def record_namespace
+        'fileCabinet'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/list_acct.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module ListAcct
+
+      def record_namespace
+        'listAcct'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/list_emp.rb

@@ -0,0 +1,12 @@
+module NetSuite
+  module Namespaces
+    module ListEmp
+
+      # https://webservices.netsuite.com/xsd/lists/v2025_2_0/employees.xsd
+      def record_namespace
+        'listEmp'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/list_mkt.rb

@@ -0,0 +1,12 @@
+module NetSuite
+  module Namespaces
+    module ListMkt
+
+      # https://webservices.netsuite.com/xsd/lists/v2025_2_0/marketing.xsd
+      def record_namespace
+        'listMkt'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/list_rel.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module ListRel
+
+      def record_namespace
+        'listRel'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/list_support.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  	module Namespaces
+    	module ListSupport
+
+    		def record_namespace
+        		'listSupport'
+      		end
+      		
+    	end
+	end
+end

data/lib/netsuite/namespaces/list_website.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module ListWebsite
+
+      def record_namespace
+        'listWebsite'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/platform_common.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module PlatformCommon
+
+      def record_namespace
+        'platformCommon'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/platform_core.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module PlatformCore
+
+      def record_namespace
+        'platformCore'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/setup_custom.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module SetupCustom
+
+      def record_namespace
+        'setupCustom'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/tran_bank.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module TranBank
+
+      def record_namespace
+        'tranBank'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/tran_cust.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module TranCust
+
+      def record_namespace
+        'tranCust'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/tran_emp.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module TranEmp
+
+      def record_namespace
+        'tranEmp'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/tran_general.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module TranGeneral
+
+      def record_namespace
+        'tranGeneral'
+      end
+
+    end
+  end
+end

data/lib/netsuite/namespaces/tran_invt.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Namespaces
+    module TranInvt
+
+      def record_namespace
+        'tranInvt'
+      end
+
+    end
+  end
+end