netsuite-soap 2025.2.3

data/lib/netsuite/actions/async_upsert_list.rb

@@ -0,0 +1,53 @@
+# https://system.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/asyncUpsertList.html
+module NetSuite
+  module Actions
+    class AsyncUpsertList < UpsertList
+      include AsyncResponse
+
+      private
+
+      MAX_RECORDS = 200
+
+      def initialize(*objects)
+        if objects.size > MAX_RECORDS
+          raise ArgumentError, "asyncUpsertList supports a maximum of #{MAX_RECORDS} records per request (#{objects.size} given)"
+        end
+        super
+      end
+
+      def async_response_key
+        :async_upsert_list_response
+      end
+
+      def action_name
+        :async_upsert_list
+      end
+
+      module Support
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def async_upsert_list(records, credentials = {})
+            netsuite_records = records.map do |r|
+              if r.kind_of?(self)
+                r
+              else
+                self.new(r)
+              end
+            end
+
+            response = NetSuite::Actions::AsyncUpsertList.call(netsuite_records, credentials)
+
+            if response.success?
+              response.body
+            else
+              false
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/netsuite/actions/attach_file.rb

@@ -0,0 +1,87 @@
+module NetSuite
+  module Actions
+    class AttachFile < AbstractAction
+      include Support::Requests
+
+      def initialize(object, file)
+        @object = object
+        @file   = file
+      end
+
+      private
+
+      # <soap:Body>
+      #   <platformMsgs:attach>
+      #     <platformCore:attachReference xsi:type="platformCore:AttachContactReference">
+      #       <platformCore::attachTo internalId="176" type="customer" xsi:type="platformCore::RecordRef">
+      #       </platformCore:attachTo>
+      #       <platformCore:attachRecord internalId="1467" type="file" xsi:type="platformCore:RecordRef"/>
+      #     </platformCore:attachReference>
+      #   </platformMsgs:attach>
+      # </soap:Body>
+
+      def request_body
+        {
+          'platformCore:attachReference' => {
+            '@xsi:type' => 'platformCore:AttachBasicReference',
+            'platformCore:attachTo' => {
+              '@internalId' => @object.internal_id,
+              '@type' => @object.netsuite_type,
+              '@xsi:type' => 'platformCore:RecordRef'
+            },
+            'platformCore:attachedRecord' => {
+              '@internalId' => @file.internal_id,
+              '@type' => 'file',
+              '@xsi:type' => 'platformCore:RecordRef'
+            }
+          }
+        }
+      end
+
+      def success?
+        @success ||= response_hash[:status][:@is_success] == 'true'
+      end
+
+      def response_body
+        @response_body ||= response_hash[:base_ref]
+      end
+
+      def response_errors
+        if response_hash[:status] && response_hash[:status][:status_detail]
+          @response_errors ||= errors
+        end
+      end
+
+      def response_hash
+        @response_hash ||= @response.to_hash[:attach_response][:write_response]
+      end
+
+      def action_name
+        :attach
+      end
+
+      def errors
+        error_obj = response_hash[:status][:status_detail]
+        error_obj = [error_obj] if error_obj.class == Hash
+        error_obj.map do |error|
+          NetSuite::Error.new(error)
+        end
+      end
+
+      module Support
+        def attach_file(file, credentials = {})
+          response = NetSuite::Actions::AttachFile.call([self, file], credentials)
+
+          @errors = response.errors
+
+          if response.success?
+            @internal_id = response.body[:@internal_id]
+            true
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/netsuite/actions/check_async_status.rb

@@ -0,0 +1,29 @@
+# https://system.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/checkAsyncStatus.html
+module NetSuite
+  module Actions
+    class CheckAsyncStatus < AbstractAction
+      include Support::Requests
+      include AsyncResponse
+
+      def initialize(job_id)
+        @job_id = job_id
+      end
+
+      private
+
+      def request_body
+        {
+          'platformMsgs:jobId' => @job_id
+        }
+      end
+
+      def async_response_key
+        :check_async_status_response
+      end
+
+      def action_name
+        :check_async_status
+      end
+    end
+  end
+end

data/lib/netsuite/actions/delete.rb

@@ -0,0 +1,102 @@
+# https://system.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/delete.html
+module NetSuite
+  module Actions
+    class Delete < AbstractAction
+      include Support::Requests
+
+      def initialize(object = nil, options = {})
+        @object  = object
+        @options = options
+      end
+
+      private
+
+      def soap_type
+        NetSuite::Support::Records.netsuite_type(@object)
+      end
+
+      # <soap:Body>
+      #   <platformMsgs:delete>
+      #     <platformMsgs:baseRef internalId="980" type="customer" xsi:type="platformCore:RecordRef"/>
+      #   </platformMsgs:delete>
+      # </soap:Body>
+      def request_body
+        body = {
+          'platformMsgs:baseRef' => {
+            '@xsi:type'   => (@options[:custom] ? 'platformCore:CustomRecordRef' : 'platformCore:RecordRef')
+          },
+        }
+
+        if @object.respond_to?(:external_id) && @object.external_id
+          body['platformMsgs:baseRef']['@externalId'] = @object.external_id
+        end
+
+        if @object.respond_to?(:internal_id) && @object.internal_id
+          body['platformMsgs:baseRef']['@internalId'] = @object.internal_id
+        end
+
+        if @object.class.respond_to?(:type_id) && @object.class.type_id
+          body['platformMsgs:baseRef']['@typeId'] = @object.class.type_id
+        end
+
+        body['platformMsgs:baseRef']['@type'] = soap_type unless @options[:custom]
+
+        body
+      end
+
+      def response_hash
+        @response_hash ||= @response.to_hash[:delete_response][:write_response]
+      end
+
+      def success?
+        @success ||= response_hash[:status][:@is_success] == 'true'
+      end
+
+      def response_body
+        @response_body ||= response_hash[:base_ref]
+      end
+
+      def response_errors
+        if response_hash[:status] && response_hash[:status][:status_detail]
+          @response_errors ||= errors
+        end
+      end
+
+      def request_options
+        {
+          namespaces: {
+          'xmlns:platformMsgs' => "urn:messages_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
+          'xmlns:platformCore' => "urn:core_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com"
+          }
+        }
+      end
+
+      def action_name
+        :delete
+      end
+
+      def errors
+        error_obj = response_hash[:status][:status_detail]
+        error_obj = [error_obj] if error_obj.class == Hash
+        error_obj.map do |error|
+          NetSuite::Error.new(error)
+        end
+      end
+
+      module Support
+        def delete(options = {}, credentials={})
+          response =  if options.empty?
+                        NetSuite::Actions::Delete.call([self], credentials)
+                      else
+                        NetSuite::Actions::Delete.call([self, options], credentials)
+                      end
+
+          @errors = response.errors
+
+          response.success?
+        end
+      end
+
+    end
+  end
+end

data/lib/netsuite/actions/delete_list.rb

@@ -0,0 +1,108 @@
+module NetSuite
+  module Actions
+    class DeleteList < AbstractAction
+      include Support::Requests
+
+      def initialize(klass, options = { })
+        @klass = klass
+        @options = options
+      end
+
+      private
+
+      # <soap:Body>
+      #   <platformMsgs:deleteList>
+      #     <platformMsgs:baseRef internalId="1" type="customer" xsi:type="platformCore:RecordRef"/>
+      #     <platformMsgs:baseRef internalId="2" type="customer" xsi:type="platformCore:RecordRef"/>
+      #   </platformMsgs:deleteList>
+      # </soap:Body>
+      def request_body
+        list = @options.is_a?(Hash) ? @options[:list] : @options
+
+        formatted_list = if @options[:type_id]
+          type_id = @options[:type_id]
+          record_type = 'platformCore:CustomRecordRef'
+
+          list.map do |internal_id|
+            {
+              '@internalId' => internal_id,
+              '@typeId' => type_id,
+              '@xsi:type' => record_type
+            }
+          end
+        else
+          type = NetSuite::Support::Records.netsuite_type(@klass)
+          record_type = 'platformCore:RecordRef'
+
+          list.map do |internal_id|
+            {
+              '@internalId' => internal_id,
+              '@type' => type,
+              '@xsi:type' => record_type
+            }
+          end
+        end
+
+        {
+          baseRef: formatted_list
+        }
+      end
+
+      def response_list
+        @response_list ||= array_wrap(@response.to_hash[:delete_list_response][:write_response_list][:write_response])
+      end
+
+      def success?
+        @success ||= response_errors.nil? || response_errors.empty?
+      end
+
+      def response_errors
+        if response_list.any? { |r| r[:status][:@is_success] == 'false' }
+          @response_errors ||= errors
+        end
+      end
+
+      def request_options
+        {
+          namespaces: {
+          'xmlns:platformMsgs' => "urn:messages_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
+          'xmlns:platformCore' => "urn:core_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com"
+          }
+        }
+      end
+
+      def action_name
+        :delete_list
+      end
+
+      def errors
+        errors = response_list.select { |r| r[:status] && r[:status][:status_detail] }.map do |obj|
+          error_obj = obj[:status][:status_detail]
+          error_obj = [error_obj] if error_obj.class == Hash
+          errors = error_obj.map do |error|
+            NetSuite::Error.new(error)
+          end
+
+          [obj[:base_ref][:@internal_id], errors]
+        end
+        Hash[errors]
+      end
+
+      def response_body
+        @response_body ||= response_list
+      end
+
+      module Support
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def delete_list(options = { }, credentials={})
+            NetSuite::Actions::DeleteList.call([self, options], credentials)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/netsuite/actions/get.rb

@@ -0,0 +1,87 @@
+# https://system.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/get.html
+module NetSuite
+  module Actions
+    class Get < AbstractAction
+      include Support::Requests
+
+      def initialize(klass, options = {})
+        @klass   = klass
+        @options = options
+      end
+
+      private
+
+      def soap_type
+        NetSuite::Support::Records.netsuite_type(@klass)
+      end
+
+      # <soap:Body>
+      #   <platformMsgs:get>
+      #     <platformMsgs:baseRef internalId="983" type="customer" xsi:type="platformCore:RecordRef">
+      #       <platformCore:name/>
+      #     </platformMsgs:baseRef>
+      #   </platformMsgs:get>
+      # </soap:Body>
+      def request_body
+        body = {
+          'platformMsgs:baseRef' => {
+            '@xsi:type'  => (@options[:custom] ? 'platformCore:CustomRecordRef' : 'platformCore:RecordRef')
+          }
+        }
+        body['platformMsgs:baseRef']['@externalId'] = @options[:external_id] if @options[:external_id]
+        body['platformMsgs:baseRef']['@internalId'] = @options[:internal_id] if @options[:internal_id]
+        body['platformMsgs:baseRef']['@typeId']     = @options[:type_id]     if @options[:type_id]
+        body['platformMsgs:baseRef']['@type']       = soap_type              unless @options[:custom]
+        body
+      end
+
+      def success?
+        @success ||= response_hash[:status][:@is_success] == 'true'
+      end
+
+      def response_body
+        @response_body ||= response_hash[:record]
+      end
+
+      def response_hash
+        @response_hash = @response.body[:get_response][:read_response]
+      end
+
+      def request_options
+        {
+          namespaces: {
+          'xmlns:platformMsgs' => "urn:messages_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
+          'xmlns:platformCore' => "urn:core_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com"
+          }
+        }
+      end
+
+      def action_name
+        :get
+      end
+
+      module Support
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+
+          def get(options = {}, credentials = {})
+            options = { :internal_id => options } unless options.is_a?(Hash)
+
+            response = NetSuite::Actions::Get.call([self, options], credentials)
+            if response.success?
+             new(response.body)
+            else
+             raise RecordNotFound, "#{self} with OPTIONS=#{options.inspect} could not be found"
+            end
+          end
+
+        end
+      end
+
+    end
+  end
+end

data/lib/netsuite/actions/get_all.rb

@@ -0,0 +1,78 @@
+# https://system.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/getAll.html
+module NetSuite
+  module Actions
+    class GetAll < AbstractAction
+      include Support::Requests
+
+      def initialize(klass)
+        @klass   = klass
+      end
+
+      private
+
+      # <soap:Body>
+      #   <platformMsgs:getAll>
+      #     <record>
+      #       <recordType>salesTaxItem</recordType>
+      #     </record>
+      #   </platformMsgs:getAll>
+      # </soap:Body>
+      def request_body
+        type = @klass.to_s.split('::').last.sub(/[A-Z]/) { |m| m[0].downcase }
+
+        {
+          record: [
+            record_type: type
+          ]
+        }
+      end
+
+      def success?
+        @success ||= response_hash[:status][:@is_success] == 'true'
+      end
+
+      def response_body
+        @response_body ||= if success?
+          array_wrap(response_hash[:record_list][:record])
+        else
+          nil
+        end
+      end
+
+      def response_hash
+        @response_hash ||= @response.body[:get_all_response][:get_all_result]
+      end
+
+      def request_options
+        {
+          element_form_default: :unqualified
+        }
+      end
+
+      def action_name
+        :get_all
+      end
+
+      module Support
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def get_all(credentials = {})
+            response = NetSuite::Actions::GetAll.call([self], credentials)
+
+            # TODO expose errors to the user
+
+            if response.success?
+              response.body.map { |attr| new(attr) }
+            else
+              false
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/netsuite/actions/get_async_result.rb

@@ -0,0 +1,35 @@
+# https://system.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/getAsyncResult.html
+module NetSuite
+  module Actions
+    class GetAsyncResult < AbstractAction
+      include Support::Requests
+      include AsyncResponse
+
+      def initialize(job_id, page_index)
+        @job_id = job_id
+        @page_index = page_index
+      end
+
+      private
+
+      def request_body
+        {
+          'platformMsgs:jobId'    => @job_id,
+          'platformMsgs:pageIndex' => @page_index
+        }
+      end
+
+      def async_response_key
+        :get_async_result_response
+      end
+
+      def async_result_key
+        :async_result
+      end
+
+      def action_name
+        :get_async_result
+      end
+    end
+  end
+end

data/lib/netsuite/actions/get_deleted.rb

@@ -0,0 +1,92 @@
+module NetSuite
+  module Actions
+    class GetDeleted < AbstractAction
+      include Support::Requests
+
+      def initialize(object = nil, options = {})
+        @object  = object
+        @options = options
+      end
+
+      private
+
+      def soap_type
+        NetSuite::Support::Records.netsuite_type(@object)
+      end
+
+      # <soap:Body>
+      #   <platformMsgs:getDeleted>
+      #     <platformMsgs:pageIndex>1</platformMsgs:pageIndex>
+      #     <platformMsgs:getDeletedFilter>
+      #       <platformCore:deletedDate operator="within">
+      #         <platformCore:searchValue>2016-12-01T00:00:00</platformCore:searchValue>
+      #         <platformCore:searchValue2>2016-12-20T00:00:00</platformCore:searchValue2>
+      #       </platformCore:deletedDate>
+      #       <platformCore:type operator="anyOf">
+      #         <platformCore:searchValue>invoice</platformCore:searchValue>
+      #       </platformCore:type>
+      #     </platformMsgs:getDeletedFilter>
+      #   </platformMsgs:getDeleted>
+      # </soap:Body>
+      def request_body
+        criteria = @options[:criteria] || @options
+        filter_elements = {}
+
+        criteria.each do |c|
+          searchValue = { "@operator" => c[:operator] }
+
+          if c[:value].is_a?(Array) && c[:type] == 'SearchDateField'
+            searchValue["platformCore:searchValue"] = c[:value][0].to_s
+            searchValue["platformCore:searchValue2"] = c[:value][1].to_s
+          else
+            searchValue["platformCore:searchValue"] = c[:value]
+          end
+
+          filter_elements["platformCore:#{c[:field]}"] = searchValue
+        end
+
+        {
+          'platformMsgs:pageIndex' => @options.fetch(:page, 1),
+          'platformMsgs:getDeletedFilter' => filter_elements
+        }
+      end
+
+      def response_hash
+        @response.body[:get_deleted_response]
+      end
+
+      def success?
+        @success ||= response_body[:status][:@is_success] == 'true'
+      end
+
+      def response_body
+        @response_body ||= response_hash[:get_deleted_result]
+      end
+
+      def request_options
+        {
+          namespaces: {
+            'xmlns:platformMsgs' => "urn:messages_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
+            'xmlns:platformCore' => "urn:core_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com"
+          }
+        }
+      end
+
+      def action_name
+        :get_deleted
+      end
+
+      module Support
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def get_deleted(options = { }, credentials={})
+            NetSuite::Actions::GetDeleted.call([self, options], credentials)
+          end
+        end
+      end
+    end
+  end
+end