netsuite 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 797165a82ff004915fd35446c562b168fef1d8a8
-  data.tar.gz: 361bb3b3119d401e475df8c89e32a4c943b4f3eb
+  metadata.gz: cda0456bc8a4964f260bb7e484b64524728ea57a
+  data.tar.gz: cbf7749dc5c04d32f6bb2c59f71bb3693a1fdda5
 SHA512:
-  metadata.gz: c91ea28fb5fe26b22bfb01fa5db2006cc18cfe7c2a6957cfe87d3b08b2a734ea091bbfccd2f430eb1ceb7cc8f95c809f67feb451c4ae7681c4f4de236e752fec
-  data.tar.gz: 5d70ad8c9b507230a4f2a7db2a114eb15ea92d46801d84d89de7b002adf1f65f75e4698f869ddb6a59b570a994896b15b42ce90088e78548850581a46e0670ec
+  metadata.gz: f7e304a05344e3611a0f84741d9acf258bd10b4a6599735778514408dbd3dd1b02d5e697f07a798ab613af3ba3e77238ae394f661c66324ec2eaa38cdbf0d107
+  data.tar.gz: f083d2d5c1b982a378a151b47a8e423524727dc9fc346e25093f9f53bbc4e8e3a0cd0b49b16196643ea5cc8e1918af363e04a0ecb742ed09ed169de9f0d9ae3c

data/README.md

@@ -1,21 +1,42 @@
-[![Circle CI](https://circleci.com/gh/NetSweet/netsuite/tree/master.svg?style=svg)](https://circleci.com/gh/NetSweet/netsuite/tree/master)  
-[![Slack Status](https://opensuite-slackin.herokuapp.com/badge.svg)](http://opensuite-slackin.herokuapp.com)  
-[![Gem Version](https://badge.fury.io/rb/netsuite.svg)](http://badge.fury.io/rb/netsuite)  
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [NetSuite SuiteTalk API Ruby Gem](#netsuite-suitetalk-api-ruby-gem)
+- [Help & Support](#help--support)
+- [Testing](#testing)
+- [Installation](#installation)
+  - [Configuration](#configuration)
+    - [Token based Authentication](#token-based-authentication)
+- [Usage](#usage)
+  - [CRUD Operations](#crud-operations)
+  - [Custom Records & Fields](#custom-records--fields)
+  - [Searching](#searching)
+  - [Non-standard Operations](#non-standard-operations)
+- [About SuiteSync](#about-suitesync)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+[![Circle CI](https://circleci.com/gh/NetSweet/netsuite/tree/master.svg?style=svg)](https://circleci.com/gh/NetSweet/netsuite/tree/master)
+[![Slack Status](https://opensuite-slackin.herokuapp.com/badge.svg)](http://opensuite-slackin.herokuapp.com)
+[![Gem Version](https://badge.fury.io/rb/netsuite.svg)](http://badge.fury.io/rb/netsuite)
 [![Dependency Status](https://gemnasium.com/roidrage/lograge.svg)](https://gemnasium.com/netsweet/netsuite)
 
-# NetSuite Ruby SuiteTalk API Gem
+# NetSuite SuiteTalk API Ruby Gem
 
 * This gem will act as a wrapper around the NetSuite SuiteTalk WebServices API.
 * The gem does not cover the entire API, only the subset contributors have used so far.
-* NetSuite is a huge complex system. There's a lot to learn and sparse resources available to learn from. Here's a list of [NetSuite Development Resources](https://github.com/NetSweet/netsuite/wiki/NetSuite-Development-Resources) that might make things a bit less painful.
+* NetSuite is a complex system. There's a lot to learn and sparse resources available to learn from. Here's a list of [NetSuite Development Resources](https://github.com/NetSweet/netsuite/wiki/NetSuite-Development-Resources) that might make things a bit less painful.
 
 # Help & Support
 
-Join the [slack channel](http://opensuite-slackin.herokuapp.com) for help with any NetSuite issues.
+Join the [slack channel](http://opensuite-slackin.herokuapp.com) for help with any NetSuite issues. Please do not post usage questions as issues in GitHub.
 
-Please do not post usage questions as issues in GitHub.
+Messages in the Slack ground are [archived here](https://suitechat.slackarchive.io). Search the archives to see if your question has been answered before.
 
-## Testing
+There is some additional helpful resources for NetSuite development [listed here](https://dashboard.suitesync.io/docs/resources#netsuite).
+
+# Testing
 
 Before contributing a patch make sure all existing tests pass.
 
@@ -26,9 +47,7 @@ bundle
 bundle exec rspec
 ```
 
-## Usage
-
-### Installation
+# Installation
 
 Add this line to your application's Gemfile:
 
@@ -38,7 +57,7 @@ gem 'netsuite'
 
 This gem is built for ruby 1.9.x+, checkout the [1-8-stable](https://github.com/NetSweet/netsuite/tree/1-8-stable) branch for ruby 1.8.x support.
 
-### Configuration
+## Configuration
 
 Not sure how to find your account id? Search for "web service preferences" in the NetSuite global search.
 
@@ -53,10 +72,14 @@ NetSuite.configure do
   wsdl          "https://webservices.sandbox.netsuite.com/wsdl/v#{api_version}_0/netsuite.wsdl"
 
   # if your datacenter is being switched, you'll have to manually set your wsdl location
-  wsdl "https://webservices.na2.netsuite.com/wsdl/v#{api_version}_0/netsuite.wsdl"
+  wsdl          "https://webservices.na2.netsuite.com/wsdl/v#{api_version}_0/netsuite.wsdl"
+
+  # or specify the wsdl_domain if you want to specify the datacenter and let the configuration
+  # construct the full wsdl location - e.g. "https://#{wsdl_domain}/wsdl/v#{api_version}_0/netsuite.wsdl"
+  wsdl_domain   "webservices.na2.netsuite.com"
 
   # or specify the sandbox flag if you don't want to deal with specifying a full URL
-  sandbox	true
+  sandbox       true
 
   # often the netsuite servers will hang which would cause a timeout exception to be raised
   # if you don't mind waiting (e.g. processing NS via DJ), increasing the timeout should fix the issue
@@ -70,7 +93,7 @@ NetSuite.configure do
   password 	'password'
   account   	'12345'
   role      	1111
-  
+
   # optional, ensures that read-only fields don't cause API errors
   soap_header	'platformMsgs:preferences' => {
     'platformMsgs:ignoreReadOnlyFields' => true,
@@ -88,6 +111,8 @@ NetSuite::Configuration.soap_header = {
 }
 ```
 
+### Token based Authentication
+
 OAuth credentials are also supported. [Learn more about how to set up token based authentication here](http://mikebian.co/using-netsuites-token-based-authentication-with-suitetalk/).
 
 ```ruby
@@ -106,9 +131,9 @@ NetSuite.configure do
 end
 ```
 
-### Examples
+# Usage
 
-#### CRUD Operations
+## CRUD Operations
 
 ```ruby
 # get a customer
@@ -167,7 +192,7 @@ options = NetSuite::Records::BaseRefList.get_select_value(
 options.base_refs.map(&:name)
 ```
 
-#### Custom Records & Fields
+## Custom Records & Fields
 
 ```ruby
 # updating a custom field list on a record
@@ -218,7 +243,7 @@ NetSuite::Records::BaseRefList.get_select_value(
 )
 ```
 
-#### Searching
+## Searching
 
 ```ruby
 # basic search
@@ -379,6 +404,26 @@ NetSuite::Records::SalesOrder.search({
   }
 }).results
 
+# Search for SalesOrder records with a "Pending Approval" status using the TransactionStatus enum value.
+# https://system.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2016_2/schema/enum/transactionstatus.html
+
+NetSuite::Records::SalesOrder.search(
+  criteria: {
+    basic: [
+      {
+        field: 'type',
+        operator: 'anyOf',
+        value: ['_salesOrder'],
+      },
+      {
+        field: 'status',
+        operator: 'anyOf',
+        value: ['_salesOrderPendingApproval'],
+      },
+    ],
+  },
+)
+
 NetSuite::Records::ItemFulfillment.search({
   criteria: {
     basic: [
@@ -502,7 +547,7 @@ deposit.payment = 20
 deposit.add
 ```
 
-#### Non-standard Operations
+## Non-standard Operations
 
 ```ruby
 # making a call that hasn't been implemented yet
@@ -522,3 +567,7 @@ states = NetSuite::Configuration.connection.call(:get_all, message: {
 })
 states.to_array.first[:get_all_response][:get_all_result][:record_list][:record].map { |r| { country: r[:country], abbr: r[:shortname], name: r[:full_name] } }
 ```
+
+# About SuiteSync
+
+[SuiteSync, the Stripe-NetSuite integration](http://suitesync.io) uses this gem and funds the majority of it's development and maintenance.

data/lib/netsuite.rb

@@ -58,6 +58,7 @@ module NetSuite
     autoload :GetSelectValue,   'netsuite/actions/get_select_value'
     autoload :Initialize,       'netsuite/actions/initialize'
     autoload :Update,           'netsuite/actions/update'
+    autoload :UpdateList,       'netsuite/actions/update_list'
     autoload :Upsert,           'netsuite/actions/upsert'
     autoload :UpsertList,       'netsuite/actions/upsert_list'
     autoload :Search,           'netsuite/actions/search'
@@ -82,6 +83,9 @@ module NetSuite
     autoload :BillingScheduleRecurrenceList,    'netsuite/records/billing_schedule_recurrence_list'
     autoload :Bin,                              'netsuite/records/bin'
     autoload :BinNumberList,                    'netsuite/records/bin_number_list'
+    autoload :BinTransfer,                      'netsuite/records/bin_transfer'
+    autoload :BinTransferInventory,             'netsuite/records/bin_transfer_inventory'
+    autoload :BinTransferInventoryList,         'netsuite/records/bin_transfer_inventory_list'
     autoload :CashSale,                         'netsuite/records/cash_sale'
     autoload :CashSaleItem,                     'netsuite/records/cash_sale_item'
     autoload :CashSaleItemList,                 'netsuite/records/cash_sale_item_list'
@@ -150,6 +154,12 @@ module NetSuite
     autoload :GiftCertRedemption,               'netsuite/records/gift_cert_redemption'
     autoload :GiftCertRedemptionList,           'netsuite/records/gift_cert_redemption_list'
     autoload :Folder,                           'netsuite/records/folder'
+    autoload :InboundShipment,                  'netsuite/records/inbound_shipment'
+    autoload :InboundShipmentItem,              'netsuite/records/inbound_shipment_item'
+    autoload :InboundShipmentItemList,          'netsuite/records/inbound_shipment_item_list'
+    autoload :InterCompanyJournalEntry,         'netsuite/records/inter_company_journal_entry'
+    autoload :InterCompanyJournalEntryLine,     'netsuite/records/inter_company_journal_entry_line'
+    autoload :InterCompanyJournalEntryLineList, 'netsuite/records/inter_company_journal_entry_line_list'
     autoload :InventoryAdjustment,              'netsuite/records/inventory_adjustment'
     autoload :InventoryAdjustmentInventory,     'netsuite/records/inventory_adjustment_inventory'
     autoload :InventoryAdjustmentInventoryList, 'netsuite/records/inventory_adjustment_inventory_list'
@@ -204,6 +214,7 @@ module NetSuite
     autoload :PaymentMethod,                    'netsuite/records/payment_method'
     autoload :PayrollItem,                      'netsuite/records/payroll_item'
     autoload :PhoneCall,                        'netsuite/records/phone_call'
+    autoload :PriceLevel,                       'netsuite/records/price_level'
     autoload :PricingMatrix,                    'netsuite/records/pricing_matrix'
     autoload :PromotionCode,                    'netsuite/records/promotion_code'
     autoload :PurchaseOrder,                    'netsuite/records/purchase_order'

data/lib/netsuite/actions/search.rb

@@ -232,11 +232,6 @@ module NetSuite
         @success ||= search_result[:status][:@is_success] == 'true'
       end
 
-      protected
-        def method_name
-
-        end
-
       module Support
         def self.included(base)
           base.extend(ClassMethods)
@@ -247,7 +242,7 @@ module NetSuite
             response = NetSuite::Actions::Search.call([self, options], credentials)
 
             if response.success?
-              NetSuite::Support::SearchResult.new(response, self)
+              NetSuite::Support::SearchResult.new(response, self, credentials)
             else
               false
             end

data/lib/netsuite/actions/update_list.rb

@@ -0,0 +1,109 @@
+# https://system.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteCloudCustomizationScriptingWebServices/SuiteTalkWebServices/updateList.html
+module NetSuite
+  module Actions
+    class UpdateList
+      include Support::Requests
+
+      def initialize(*objects)
+        @objects = objects
+      end
+
+      private
+
+      def request(credentials={})
+        NetSuite::Configuration.connection(
+          { element_form_default: :unqualified }, credentials
+        ).call(:update_list, message: request_body)
+      end
+
+      # <soap:Body>
+      #   <updateList>
+      #     <record xsi:type="listRel:Customer" externalId="ext1">
+      #       <listRel:entityId>Shutter Fly</listRel:entityId>
+      #       <listRel:companyName>Shutter Fly, Inc</listRel:companyName>
+      #     </record>
+      #     <record xsi:type="listRel:Customer" externalId="ext2">
+      #       <listRel:entityId>Target</listRel:entityId>
+      #       <listRel:companyName>Target</listRel:companyName>
+      #     </record>
+      #   </updateList>
+      # </soap:Body>
+      def request_body
+        attrs = @objects.map do |o|
+          hash = o.to_record.merge({
+            '@xsi:type' => o.record_type
+          })
+
+          if o.respond_to?(:internal_id) && o.internal_id
+            hash['@internalId'] = o.internal_id
+          end
+
+          if o.respond_to?(:external_id) && o.external_id
+            hash['@externalId'] = o.external_id
+          end
+
+          hash
+        end
+
+        { 'record' => attrs }
+      end
+
+      def response_hash
+        @response_hash ||= Array[@response.body[:update_list_response][:write_response_list][:write_response]].flatten
+      end
+
+      def response_body
+        @response_body ||= response_hash.map { |h| h[:base_ref] }
+      end
+
+      def response_errors
+        if response_hash.any? { |h| h[:status] && h[:status][:status_detail] }
+          @response_errors ||= errors
+        end
+      end
+
+      def errors
+        errors = response_hash.select { |h| h[:status] && h[: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 success?
+        @success ||= response_hash.all? { |h| h[:status][:@is_success] == 'true' }
+      end
+
+      module Support
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def update_list(records, credentials = {})
+            netsuite_records = records.map do |r|
+              if r.kind_of?(self)
+                r
+              else
+                self.new(r)
+              end
+            end
+            response = NetSuite::Actions::UpdateList.call(netsuite_records, credentials)
+
+            if response.success?
+              netsuite_records
+            else
+              false
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/netsuite/records/bin_transfer.rb

@@ -0,0 +1,38 @@
+module NetSuite
+  module Records
+    class BinTransfer
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Support::Actions
+      include Namespaces::TranInvt
+
+      actions :get, :get_list, :add, :initialize, :delete, :update, :upsert, :search
+
+      fields :created_date, :last_modified_date, :memo, :subsidiary, :tran_date, :tran_id
+
+      record_refs :location
+
+      field :custom_field_list, CustomFieldList
+      field :inventory_list, BinTransferInventoryList
+
+      attr_reader :internal_id
+      attr_accessor :external_id
+
+      def initialize(attributes = {})
+        @internal_id = attributes.delete(:internal_id) || attributes.delete(:@internal_id)
+        @external_id = attributes.delete(:external_id) || attributes.delete(:@external_id)
+        initialize_from_attributes_hash(attributes)
+      end
+
+      def self.search_class_name
+        "Transaction"
+      end
+
+      def self.search_class_namespace
+        'tranSales'
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/bin_transfer_inventory.rb

@@ -0,0 +1,20 @@
+module NetSuite
+  module Records
+    class BinTransferInventory
+      include Support::Records
+      include Support::Fields
+      include Support::RecordRefs
+      include Namespaces::TranInvt
+
+      fields :description, :from_bins, :item_units_label, :line, :preferred_bin, :quantity, :to_bins
+
+      field :inventory_detail, InventoryDetail
+
+      record_refs :item
+
+      def initialize(attributes = {})
+        initialize_from_attributes_hash(attributes)
+      end
+    end
+  end
+end

data/lib/netsuite/records/bin_transfer_inventory_list.rb

@@ -0,0 +1,10 @@
+module NetSuite
+  module Records
+    class BinTransferInventoryList < Support::Sublist
+      include Namespaces::TranInvt
+
+      sublist :inventory, BinTransferInventory
+
+    end
+  end
+end

data/lib/netsuite/records/cash_refund_item.rb

@@ -6,7 +6,7 @@ module NetSuite
       include Support::Records
       include Namespaces::TranCust
 
-      fields :amount, :rate, :quantity
+      fields :amount, :rate, :quantity, :is_taxable, :order_line, :line, :description
       field :custom_field_list,    CustomFieldList
 
       record_refs :item, :klass, :price

data/lib/netsuite/records/classification.rb

@@ -9,7 +9,7 @@ module NetSuite
 
       actions :get, :get_list, :delete, :upsert, :search
 
-      fields :name, :include_children, :is_inactive, :class_translation_list, :custom_field_list
+      fields :name, :include_children, :is_inactive, :class_translation_list, :custom_field_list, :parent
 
       field :subsidiary_list, RecordRefList