netsuite 0.1.0 → 0.2.0

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in netsuite.gemspec
 gemspec

data/README.md

@@ -100,6 +100,160 @@ search = NetSuite::Records::Customer.search({
 })
 
 `open https://system.netsuite.com/app/common/entity/custjob.nl?id=#{search.results.first.internal_id}`
+
+# advanced search building on saved search
+search = NetSuite::Records::Customer.search({
+  saved: 500,	# your saved search internalId
+  basic: [
+    {
+      field: 'entityId',
+      operator: 'hasKeywords',
+      value: 'Assumption',
+    },
+    {
+      field: 'stage',
+      operator: 'anyOf',
+      type: 'SearchMultiSelectCustomField',
+      value: [
+        '_lead', '_customer'
+      ]
+    },
+    {
+      field: 'customFieldList',
+      value: [
+        {
+          field: 'custentity_acustomfield',
+          operator: 'anyOf',
+          # type is needed for multiselect fields
+          type: 'SearchMultiSelectCustomField',
+          value: [
+            NetSuite::Records::CustomRecordRef.new(:internal_id => 1),
+            NetSuite::Records::CustomRecordRef.new(:internal_id => 2),
+          ]
+        }
+      ]
+    }
+  ]
+})
+
+# advanced search from stratch
+search = NetSuite::Records::Transaction.search({
+  criteria: {
+    basic: [
+      {
+        field: 'type',
+        operator: 'anyOf',
+        type: 'SearchEnumMultiSelectField',
+        value: [ "_invoice", "_salesOrder" ]
+      },
+      {
+        field: 'tranDate',
+        operator: 'within',
+        # this is needed for date range search requests, for date requests with a single param type is not needed
+        type: 'SearchDateField',
+        value: [
+          # the following format is equivilent to ISO 8601
+          # Date.parse("1/1/2012").strftime("%Y-%m-%dT%H:%M:%S%z"),
+          # Date.parse("30/07/2013").strftime("%Y-%m-%dT%H:%M:%S%z")
+
+          # need to require the time library for this to work
+          Time.parse("01/01/2012").iso8601,
+          Time.parse("30/07/2013").iso8601,
+
+          # or you can use a string. Note that the format below is different from the format of the above code
+          # but it matches exactly what NS returns 
+          # "2012-01-01T22:00:00.000-07:00",
+          # "2013-07-30T22:00:00.000-07:00"
+        ]
+      }
+    ],
+
+
+    # equivilent to the 'Account' label in the GUI
+    accountJoin: [
+      {
+        field: 'internalId',
+        operator: 'noneOf',
+        value: [ NetSuite::Records::Account.new(:internal_id => 215) ]
+      }
+    ],
+
+    itemJoin: [
+      {
+        field: 'customFieldList',
+        value: [
+          {
+            field: 'custitem_apcategoryforsales',
+            operator: 'anyOf',
+            type: 'SearchMultiSelectCustomField',
+            value: [
+              NetSuite::Records::Customer.new(:internal_id => 1),
+              NetSuite::Records::Customer.new(:internal_id => 2),
+            ]
+          }
+        ]
+      }
+    ]
+  },
+  
+  # the column syntax is a WIP. This will change in the future
+  columns: {
+    'tranSales:basic' => [
+      'platformCommon:internalId/' => {},
+      'platformCommon:email/' => {},
+      'platformCommon:tranDate/' => {}
+    ],
+    'tranSales:accountJoin' => [
+      'platformCommon:internalId/' => {}
+    ],
+    'tranSales:contactPrimaryJoin' => [
+      'platformCommon:internalId/' => {}
+    ],
+    'tranSales:customerJoin' => [
+      'platformCommon:internalId/' => {}
+    ],
+    'tranSales:itemJoin' => [
+      'platformCommon:customFieldList' => [
+        'platformCore:customField/' => {
+          '@internalId' => 'custitem_apcategoryforsales',
+          '@xsi:type' => "platformCore:SearchColumnSelectCustomField"
+        }
+      ]
+    ]
+  },
+
+  preferences: {
+    page_size: 10
+  }
+})
+
+# basic search with pagination / SearchMorewithId
+search = NetSuite::Records::Customer.search(
+  criteria: {
+    basic: [
+      {
+        # no operator for booleans
+        field: 'isInactive',
+        value: false,
+      },
+    ]
+  },
+
+  preferences: {
+    page_size: 10,
+  }
+)
+
+search.results_in_batches do |batch|
+  puts batch.map(&:internal_id)
+end
+
+# making a call that hasn't been implemented yet
+NetSuite::Configuration.connection.call :get_customization_id, message: {
+  'platformMsgs:customizationType' => { '@getCustomizationType' => 'customRecordType'},
+  'platformMsgs:includeInactives' => 'false'
+}
+
 ```
 
 

data/lib/netsuite.rb

@@ -13,6 +13,7 @@ module NetSuite
     autoload :ActSched,       'netsuite/namespaces/act_sched'
     autoload :ListAcct,       'netsuite/namespaces/list_acct'
     autoload :ListRel,        'netsuite/namespaces/list_rel'
+    autoload :ListSupport,    'netsuite/namespaces/list_support'
     autoload :PlatformCommon, 'netsuite/namespaces/platform_common'
     autoload :PlatformCore,   'netsuite/namespaces/platform_core'
     autoload :TranCust,       'netsuite/namespaces/tran_cust'
@@ -35,6 +36,8 @@ module NetSuite
     autoload :Add,              'netsuite/actions/add'
     autoload :Delete,           'netsuite/actions/delete'
     autoload :Get,              'netsuite/actions/get'
+    autoload :GetList,          'netsuite/actions/get_list'
+    autoload :GetSelectValue,   'netsuite/actions/get_select_value'
     autoload :Initialize,       'netsuite/actions/initialize'
     autoload :Update,           'netsuite/actions/update'
     autoload :Search,           'netsuite/actions/search'
@@ -45,8 +48,10 @@ module NetSuite
     autoload :AssemblyItem,               'netsuite/records/assembly_item'
     autoload :Account,                    'netsuite/records/account'
     autoload :AccountingPeriod,           'netsuite/records/accounting_period'
+    autoload :BaseRefList,                'netsuite/records/base_ref_list'
     autoload :BillAddress,                'netsuite/records/bill_address'
     autoload :BinNumberList,              'netsuite/records/bin_number_list'
+    autoload :CashSale,                   'netsuite/records/cash_sale'
     autoload :Classification,             'netsuite/records/classification'
     autoload :CreditMemo,                 'netsuite/records/credit_memo'
     autoload :CreditMemoApply,            'netsuite/records/credit_memo_apply'
@@ -88,6 +93,7 @@ module NetSuite
     autoload :Location,                   'netsuite/records/location'
     autoload :NonInventorySaleItem,       'netsuite/records/non_inventory_sale_item'
     autoload :PaymentMethod,              'netsuite/records/payment_method'
+    autoload :PhoneCall,                  'netsuite/records/phone_call'
     autoload :PricingMatrix,              'netsuite/records/pricing_matrix'
     autoload :RecordRef,                  'netsuite/records/record_ref'
     autoload :RevRecTemplate,             'netsuite/records/rev_rec_template'
@@ -95,6 +101,7 @@ module NetSuite
     autoload :SalesOrderItem,             'netsuite/records/sales_order_item'
     autoload :SalesOrderItemList,         'netsuite/records/sales_order_item_list'
     autoload :ShipAddress,                'netsuite/records/ship_address'
+    autoload :SupportCase,                'netsuite/records/support_case'
     autoload :Task,                       'netsuite/records/task'
     autoload :Term,                       'netsuite/records/term'
     autoload :Transaction,                'netsuite/records/transaction'

data/lib/netsuite/actions/add.rb

@@ -10,20 +10,7 @@ module NetSuite
       private
 
       def request
-        NetSuite::Configuration.connection(
-          namespaces: {
-            'xmlns:platformMsgs'   => "urn:core_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
-            'xmlns:platformCore'   => "urn:core_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
-            'xmlns:listRel'        => "urn:relationships_#{NetSuite::Configuration.api_version}.lists.webservices.netsuite.com",
-            'xmlns:tranSales'      => "urn:sales_#{NetSuite::Configuration.api_version}.transactions.webservices.netsuite.com",
-            'xmlns:platformCommon' => "urn:common_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
-            'xmlns:listAcct'       => "urn:accounting_#{NetSuite::Configuration.api_version}.lists.webservices.netsuite.com",
-            'xmlns:actSched'       => "urn:scheduling_#{NetSuite::Configuration.api_version}.activities.webservices.netsuite.com",
-            'xmlns:tranCust'       => "urn:customers_#{NetSuite::Configuration.api_version}.transactions.webservices.netsuite.com",
-            'xmlns:setupCustom'    => "urn:customization_#{NetSuite::Configuration.api_version}.setup.webservices.netsuite.com",
-            'xmlns:tranGeneral'    => "urn:general_#{NetSuite::Configuration.api_version}.transactions.webservices.netsuite.com",
-          },
-        ).call :add, :message => request_body
+        NetSuite::Configuration.connection.call :add, :message => request_body
       end
 
       # <soap:Body>
@@ -37,20 +24,18 @@ module NetSuite
 
       def request_body
         hash = {
-          'platformMsgs:record' => @object.to_record,
-          :attributes! => {
-            'platformMsgs:record' => {
-              'xsi:type' => @object.record_type
-            }
+          'platformMsgs:record' => {
+            :content! => @object.to_record,
+            '@xsi:type' => @object.record_type
           }
         }
 
         if @object.respond_to?(:internal_id) && @object.internal_id
-          hash[:attributes!]['platformMsgs:record']['platformMsgs:internalId'] = @object.internal_id
+          hash['platformMsgs:record']['@platformMsgs:internalId'] = @object.internal_id
         end
 
         if @object.respond_to?(:external_id) && @object.external_id
-          hash[:attributes!]['platformMsgs:record']['platformMsgs:externalId'] = @object.external_id
+          hash['platformMsgs:record']['@platformMsgs:externalId'] = @object.external_id
         end
         
         hash

data/lib/netsuite/actions/delete.rb

@@ -30,27 +30,24 @@ module NetSuite
       # </soap:Body>
       def request_body
         body = {
-          'platformMsgs:baseRef' => {},
-          :attributes! => {
-            'platformMsgs:baseRef' => {
-              'xsi:type'   => (@options[:custom] ? 'platformCore:CustomRecordRef' : 'platformCore:RecordRef')
-            }
-          }
+          'platformMsgs:baseRef' => {
+            '@xsi:type'   => (@options[:custom] ? 'platformCore:CustomRecordRef' : 'platformCore:RecordRef')
+          },
         }
 
         if @object.respond_to?(:external_id) && @object.external_id
-          body[:attributes!]['platformMsgs:baseRef']['externalId'] = @object.external_id
+          body['platformMsgs:baseRef']['@externalId'] = @object.external_id
         end
 
         if @object.respond_to?(:internal_id) && @object.internal_id
-          body[:attributes!]['platformMsgs:baseRef']['internalId'] = @object.internal_id
+          body['platformMsgs:baseRef']['@internalId'] = @object.internal_id
         end
 
         if @object.class.respond_to?(:type_id) && @object.class.type_id
-          body[:attributes!]['platformMsgs:baseRef']['typeId'] = @object.class.type_id
+          body['platformMsgs:baseRef']['@typeId'] = @object.class.type_id
         end
 
-        body[:attributes!]['platformMsgs:baseRef']['type'] = soap_type unless @options[:custom]
+        body['platformMsgs:baseRef']['@type'] = soap_type unless @options[:custom]
 
         body
       end

data/lib/netsuite/actions/get.rb

@@ -16,7 +16,7 @@ module NetSuite
             'xmlns:platformMsgs' => "urn:messages_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com",
             'xmlns:platformCore' => "urn:core_#{NetSuite::Configuration.api_version}.platform.webservices.netsuite.com"
           },
-        ).call :get, message: request_body#, message_tag: :platformMsgs
+        ).call :get, message: request_body
       end
 
       def soap_type
@@ -32,17 +32,14 @@ module NetSuite
       # </soap:Body>
       def request_body
         body = {
-          'platformMsgs:baseRef' => {},
-          :attributes! => {
-            'platformMsgs:baseRef' => {
-              'xsi:type'  => (@options[:custom] ? 'platformCore:CustomRecordRef' : 'platformCore:RecordRef')
-            }
+          'platformMsgs:baseRef' => {
+            '@xsi:type'  => (@options[:custom] ? 'platformCore:CustomRecordRef' : 'platformCore:RecordRef')
           }
         }
-        body[:attributes!]['platformMsgs:baseRef']['externalId'] = @options[:external_id] if @options[:external_id]
-        body[:attributes!]['platformMsgs:baseRef']['internalId'] = @options[:internal_id] if @options[:internal_id]
-        body[:attributes!]['platformMsgs:baseRef']['typeId']     = @options[:type_id]     if @options[:type_id]
-        body[:attributes!]['platformMsgs:baseRef']['type']       = soap_type              unless @options[:custom]
+        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
 

data/lib/netsuite/actions/get_list.rb

@@ -0,0 +1,77 @@
+module NetSuite
+  module Actions
+    class GetList
+      include Support::Requests
+
+      def initialize(klass, options = { })
+        @klass = klass
+        @options = options
+      end
+
+      private
+
+      def request
+        NetSuite::Configuration.connection.call :get_list, :message => request_body
+      end
+
+      def request_body
+        if @options[:type_id]
+          type = @options[:type_id]
+          record_type = 'platformCore:CustomRecordRef'
+        else
+          type = @klass.to_s.split('::').last.lower_camelcase
+          record_type = 'platformCore:RecordRef'
+        end
+
+        list = @options.is_a?(Hash) ? @options[:list] : @options
+
+        {
+          baseRef: list.map do |internal_id|
+            {
+              '@internalId' => internal_id,
+              '@typeId' => type,
+              '@xsi:type' => record_type
+            }
+          end
+        }
+      end
+
+      def response_header
+        @response_header ||= response_header_hash
+      end
+
+      def response_header_hash
+        @response_header_hash = @response.header[:document_info]
+      end
+
+      def response_body
+        @response_body ||= @response.body[:get_list_response][:read_response_list][:read_response]
+      end
+
+      def success?
+        # each returned record has its own status; for now if one fails, the entire operation has failed
+        @success ||= response_body.detect { |r| r[:status][:@is_success] != 'true' }.nil?
+      end
+
+      module Support
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def get_list(options = { })
+            response = NetSuite::Actions::GetList.call(self, options)
+
+            if response.success?
+              response.body.map do |record|
+                new(record[:record])
+              end
+            else
+              false
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/netsuite/actions/get_select_value.rb

@@ -0,0 +1,71 @@
+module NetSuite
+  module Actions
+    class GetSelectValue
+      include Support::Requests
+
+      def initialize(klass, options = {})
+        @klass   = klass
+        @options = options
+      end
+
+      private
+
+      def request
+        NetSuite::Configuration.connection(
+          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"
+          },
+        ).call :get_select_value, :message => @options
+      end
+
+      def success?
+        @success ||= response_hash[:status][:@is_success] == 'true'
+      end
+
+      def response_body
+        @response_body ||= response_hash[:base_ref_list]
+      end
+
+      def response_hash
+        @response_hash = @response.body[:get_select_value_response][:get_select_value_result]
+      end
+
+      module Support
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+
+          def get_select_value(options = {})
+            message = {
+              pageIndex: (options.delete(:pageIndex) || 1),
+              fieldDescription: field_description(options)
+            }
+
+            response = NetSuite::Actions::GetSelectValue.call(self, message)
+
+            if response.success?
+              new(response.body)
+            else
+              raise RecordNotFound, "#{self} with OPTIONS=#{options.inspect} could not be found"
+            end
+          end
+
+          private
+            # TODO this goes against the design of the rest of the gem; should be removed in the future
+            def field_description(options)
+              options.inject({}) do |h, (k, v)|
+                h["platformCore:#{k}"] = v
+                h
+              end
+            end
+
+        end
+      end
+
+    end
+  end
+end