netsuite 0.8.2 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 797165a82ff004915fd35446c562b168fef1d8a8
-  data.tar.gz: 361bb3b3119d401e475df8c89e32a4c943b4f3eb
+SHA256:
+  metadata.gz: 3c52f30c1f82b68e1ac2e078d81eed79f6c34ec0cc5937dd4251a53cb9a5a5c0
+  data.tar.gz: 4208277a164ec0b92520cef24b19367538788ecce870cd37f683ddb9fb85143e
 SHA512:
-  metadata.gz: c91ea28fb5fe26b22bfb01fa5db2006cc18cfe7c2a6957cfe87d3b08b2a734ea091bbfccd2f430eb1ceb7cc8f95c809f67feb451c4ae7681c4f4de236e752fec
-  data.tar.gz: 5d70ad8c9b507230a4f2a7db2a114eb15ea92d46801d84d89de7b002adf1f65f75e4698f869ddb6a59b570a994896b15b42ce90088e78548850581a46e0670ec
+  metadata.gz: bd8c7a34e1ecced72b398715f17978677bc87021e0bc9581449299f918b51993770d956eb3553775c1631ef16c8e488e6ffe682d9575665d81434106635f7e53
+  data.tar.gz: f40134f2aaf8824e9b51f9dba00a8a4d9b3b1e935df0d0d07f100018becf8180f6b603f63e52331e65877bbeb135de491fed75a9c5af0928e7409eedbc2f62b4

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 vendor/
+.tags*

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.6.6

data/Gemfile

@@ -2,10 +2,15 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'simplecov', :require => false
+gem 'rspec_junit_formatter'
 
 gem 'pry-nav'
 gem 'pry-rescue'
 
+# optional dependency for more accurate timezone conversion
+gem 'tzinfo', '1.2.5'
+# gem 'tzinfo', '2.0.0'
+
 # required for CircleCI to build properly with ruby 1.9.3
-gem 'json', '~> 1.8.3'
-gem 'rack', '~> 1.6.4'
+gem 'json', '~> 2.3.0'
+gem 'rack', '~> 2.1.4'

data/README.md

@@ -1,21 +1,41 @@
-[![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
+<!-- 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)
+
+# 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.
+
+Messages in the Slack ground are [archived here](https://suitechat.slackarchive.io). Search the archives to see if your question has been answered before.
 
-Please do not post usage questions as issues in GitHub.
+There is some additional helpful resources for NetSuite development [listed here](https://dashboard.suitesync.io/docs/resources#netsuite).
 
-## Testing
+# Testing
 
 Before contributing a patch make sure all existing tests pass.
 
@@ -26,9 +46,7 @@ bundle
 bundle exec rspec
 ```
 
-## Usage
-
-### Installation
+# Installation
 
 Add this line to your application's Gemfile:
 
@@ -36,41 +54,72 @@ Add this line to your application's Gemfile:
 gem 'netsuite'
 ```
 
+If you'd like more accurate time conversion support, include the `tzinfo` gem.
+
 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
+
+The most important thing you'll need is your NetSuite account ID. Not sure how to find your account id? [Here's a guide.](http://mikebian.co/find-netsuite-web-services-account-number/)
+
+For most use-cases, the following configuration will be sufficient:
+
+```ruby
+NetSuite.configure do
+  reset!
+
+  account  'TSTDRV1576318'
+  api_version '2018_2'
+
+  email 'email@example.com'
+  password 'password'
+  role 10
 
-Not sure how to find your account id? Search for "web service preferences" in the NetSuite global search.
+  # use `NetSuite::Utilities.data_center_url('TSTDRV1576318')` to retrieve the URL
+  # you'll want to do this in a background process and strip the protocol out of the return string
+  wsdl_domain 'tstdrv1576318.suitetalk.api.netsuite.com'
+end
+```
+
+The `wsdl_domain` configuration is most important. Note that if you use `wsdl` or other configuration options below, you'll want to look at the configuration source to understand more about how the different options interact with each other. Some of the configuration options will mutate the state of other options.
+
+Here's the various options that are are available for configuration:
 
 ```ruby
 NetSuite.configure do
   reset!
 
-  # optional, defaults to 2011_2
-  api_version	'2012_1'
+  api_version	'2018_2'
 
   # optionally specify full wsdl URL (to switch to sandbox, for example)
   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 sandbox flag if you don't want to deal with specifying a full URL
-  sandbox	true
+  # 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"
 
   # 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
-  read_timeout  100000
+  # if you don't mind waiting (e.g. processing NS via a background worker), increasing the timeout should fix the issue
+  read_timeout  100_000
 
   # you can specify a file or file descriptor to send the log output to (defaults to STDOUT)
+  # If using within a Rails app, consider setting to `Rails.logger` to leverage existing
+  # application-level log configuration
   log           File.join(Rails.root, 'log/netsuite.log')
 
-  # login information
-  email    	'email@domain.com'
-  password 	'password'
+  # Defaults to :debug level logging for Savon API calls. Decrease the verbosity
+  # by setting log_level to `:info`, for example
+  # log_level   :debug
+
+  # password-based login information
+  email    	  'email@domain.com'
+  password 	  'password'
   account   	'12345'
-  role      	1111
-  
+  role        1111
+
   # optional, ensures that read-only fields don't cause API errors
   soap_header	'platformMsgs:preferences' => {
     'platformMsgs:ignoreReadOnlyFields' => true,
@@ -88,6 +137,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 +157,9 @@ NetSuite.configure do
 end
 ```
 
-### Examples
+# Usage
 
-#### CRUD Operations
+## CRUD Operations
 
 ```ruby
 # get a customer
@@ -167,7 +218,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 +269,7 @@ NetSuite::Records::BaseRefList.get_select_value(
 )
 ```
 
-#### Searching
+## Searching
 
 ```ruby
 # basic search
@@ -379,6 +430,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 +573,7 @@ deposit.payment = 20
 deposit.add
 ```
 
-#### Non-standard Operations
+## Non-standard Operations
 
 ```ruby
 # making a call that hasn't been implemented yet
@@ -522,3 +593,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/circle.yml

@@ -1,16 +1,36 @@
-# https://leonid.shevtsov.me/post/multiple-rubies-on-circleci/
+version: 2.1
 
-machine:
-  environment:
-    RUBY_VERSIONS: 2.0.0,2.1.10,2.2.5,2.3.1,2.4.0
+orbs:
+  # orbs are basically bundles of pre-written build scripts that work for common cases
+  # https://github.com/CircleCI-Public/ruby-orb
+  ruby: circleci/ruby@1.1
 
-dependencies:
-  override:
-    - rvm get head
-    - rvm install $RUBY_VERSIONS
-    - rvm $RUBY_VERSIONS --verbose do gem install bundler
-    - rvm $RUBY_VERSIONS --verbose do bundle install
+jobs:
+  # skipping build step because Gemfile.lock is not included in the source
+  # this makes the bundler caching step a noop
+  test:
+    parameters:
+      ruby-version:
+        type: string
+    docker:
+      - image: cimg/ruby:<< parameters.ruby-version >>
+    steps:
+      - checkout
+      - ruby/install-deps:
+          bundler-version: '1.17.2'
+          with-cache: false
+      - ruby/rspec-test
 
-test:
-  override:
-    - rvm $RUBY_VERSIONS --verbose do bundle exec rspec spec
+# strangely, there seems to be very little documentation about exactly how martix builds work.
+# By defining a param inside your job definition, Circle CI will automatically spawn a job for
+# unique param value passed via `matrix`. Neat!
+# https://circleci.com/blog/circleci-matrix-jobs/
+workflows:
+  build_and_test:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              # https://github.com/CircleCI-Public/cimg-ruby
+              # only supports the last three ruby versions
+              ruby-version: ["2.5", "2.6", "2.7"]

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'
@@ -81,7 +82,11 @@ module NetSuite
     autoload :BillingScheduleRecurrence,        'netsuite/records/billing_schedule_recurrence'
     autoload :BillingScheduleRecurrenceList,    'netsuite/records/billing_schedule_recurrence_list'
     autoload :Bin,                              'netsuite/records/bin'
+    autoload :BinNumber,                        'netsuite/records/bin_number'
     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'
@@ -107,6 +112,8 @@ module NetSuite
     autoload :CustomerAddressbook,              'netsuite/records/customer_addressbook'
     autoload :CustomerAddressbookList,          'netsuite/records/customer_addressbook_list'
     autoload :CustomerCategory,                 'netsuite/records/customer_category'
+    autoload :CustomerCreditCards,              'netsuite/records/customer_credit_cards'
+    autoload :CustomerCreditCardsList,          'netsuite/records/customer_credit_cards_list'
     autoload :CustomerCurrency,                 'netsuite/records/customer_currency'
     autoload :CustomerCurrencyList,             'netsuite/records/customer_currency_list'
     autoload :CustomerDeposit,                  'netsuite/records/customer_deposit'
@@ -116,12 +123,18 @@ module NetSuite
     autoload :CustomerPayment,                  'netsuite/records/customer_payment'
     autoload :CustomerPaymentApply,             'netsuite/records/customer_payment_apply'
     autoload :CustomerPaymentApplyList,         'netsuite/records/customer_payment_apply_list'
+    autoload :CustomerPartner,                  'netsuite/records/customer_partner'
     autoload :CustomerRefund,                   'netsuite/records/customer_refund'
     autoload :CustomerRefundApply,              'netsuite/records/customer_refund_apply'
     autoload :CustomerRefundApplyList,          'netsuite/records/customer_refund_apply_list'
     autoload :CustomerRefundDeposit,            'netsuite/records/customer_refund_deposit'
     autoload :CustomerRefundDepositList,        'netsuite/records/customer_refund_deposit_list'
+    autoload :CustomerSubscription,             'netsuite/records/customer_subscription'
+    autoload :CustomerSubscriptionsList,        'netsuite/records/customer_subscriptions_list'
+    autoload :CustomerStatus,                   'netsuite/records/customer_status'
     autoload :CustomerPartner,                  'netsuite/records/customer_partner'
+    autoload :CustomerSalesTeam,                'netsuite/records/customer_sales_team'
+    autoload :CustomerSalesTeamList,            'netsuite/records/customer_sales_team_list'
     autoload :ContactList,                      'netsuite/records/contact_list'
     autoload :Contact,                          'netsuite/records/contact'
     autoload :ContactAddressbook,               'netsuite/records/contact_addressbook'
@@ -144,12 +157,22 @@ module NetSuite
     autoload :DiscountItem,                     'netsuite/records/discount_item'
     autoload :Duration,                         'netsuite/records/duration'
     autoload :Employee,                         'netsuite/records/employee'
+    autoload :EntityCustomField,                'netsuite/records/entity_custom_field'
+    autoload :Estimate,                         'netsuite/records/estimate'
+    autoload :EstimateItem,                     'netsuite/records/estimate_item'
+    autoload :EstimateItemList,                 'netsuite/records/estimate_item_list'
     autoload :File,                             'netsuite/records/file'
     autoload :GiftCertificate,                  'netsuite/records/gift_certificate'
     autoload :GiftCertificateItem,              'netsuite/records/gift_certificate_item'
     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'
@@ -188,8 +211,10 @@ module NetSuite
     autoload :Location,                         'netsuite/records/location'
     autoload :LocationsList,                    'netsuite/records/locations_list'
     autoload :LotNumberedAssemblyItem,          'netsuite/records/lot_numbered_assembly_item'
+    autoload :LotNumberedInventoryItem,         'netsuite/records/lot_numbered_inventory_item'
     autoload :MatrixOptionList,                 'netsuite/records/matrix_option_list'
     autoload :MemberList,                       'netsuite/records/member_list'
+    autoload :Message,                          'netsuite/records/message'
     autoload :NonInventorySaleItem,             'netsuite/records/non_inventory_sale_item'
     autoload :NonInventoryPurchaseItem,         'netsuite/records/non_inventory_purchase_item'
     autoload :NonInventoryResaleItem,           'netsuite/records/non_inventory_resale_item'
@@ -204,8 +229,14 @@ module NetSuite
     autoload :PaymentMethod,                    'netsuite/records/payment_method'
     autoload :PayrollItem,                      'netsuite/records/payroll_item'
     autoload :PhoneCall,                        'netsuite/records/phone_call'
+    autoload :Price,                            'netsuite/records/price'
+    autoload :PriceLevel,                       'netsuite/records/price_level'
+    autoload :PriceList,                        'netsuite/records/price_list'
+    autoload :Pricing,                          'netsuite/records/pricing'
     autoload :PricingMatrix,                    'netsuite/records/pricing_matrix'
     autoload :PromotionCode,                    'netsuite/records/promotion_code'
+    autoload :PromotionsList,                   'netsuite/records/promotions_list'
+    autoload :Promotions,                       'netsuite/records/promotions'
     autoload :PurchaseOrder,                    'netsuite/records/purchase_order'
     autoload :PurchaseOrderItemList,            'netsuite/records/purchase_order_item_list'
     autoload :PurchaseOrderItem,                'netsuite/records/purchase_order_item'
@@ -222,9 +253,11 @@ module NetSuite
     autoload :SalesOrderShipGroupList,          'netsuite/records/sales_order_ship_group_list'
     autoload :SalesOrderItem,                   'netsuite/records/sales_order_item'
     autoload :SalesOrderItemList,               'netsuite/records/sales_order_item_list'
+    autoload :SalesRole,                        'netsuite/records/sales_role'
     autoload :SalesTaxItem,                     'netsuite/records/sales_tax_item'
     autoload :ServiceResaleItem,                'netsuite/records/service_resale_item'
     autoload :ServiceSaleItem,                  'netsuite/records/service_sale_item'
+    autoload :SerializedAssemblyItem,          'netsuite/records/serialized_assembly_item'
     autoload :SerializedInventoryItem,          'netsuite/records/serialized_inventory_item'
     autoload :SerializedInventoryItemNumbers,       'netsuite/records/serialized_inventory_item_numbers'
     autoload :SerializedInventoryItemNumbersList,   'netsuite/records/serialized_inventory_item_numbers_list'
@@ -235,11 +268,14 @@ module NetSuite
     autoload :Subsidiary,                       'netsuite/records/subsidiary'
     autoload :SubtotalItem,                     'netsuite/records/subtotal_item'
     autoload :SupportCase,                      'netsuite/records/support_case'
+    autoload :SupportCaseType,                  'netsuite/records/support_case_type'
     autoload :TaxType,                          'netsuite/records/tax_type'
     autoload :TaxGroup,                         'netsuite/records/tax_group'
     autoload :Task,                             'netsuite/records/task'
     autoload :Term,                             'netsuite/records/term'
     autoload :TimeBill,                         'netsuite/records/time_bill'
+    autoload :TransactionBodyCustomField,       'netsuite/records/transaction_body_custom_field'
+    autoload :TransactionColumnCustomField,     'netsuite/records/transaction_column_custom_field'
     autoload :TransactionShipGroup,             'netsuite/records/transaction_ship_group'
     autoload :TransferOrder,                    'netsuite/records/transfer_order'
     autoload :TransferOrderItemList,            'netsuite/records/transfer_order_item_list'
@@ -281,23 +317,4 @@ module NetSuite
     NetSuite::Configuration.instance_eval(&block)
   end
 
-  def self.configure_from_env(&block)
-    NetSuite.configure do
-      reset!
-
-      email         ENV['NETSUITE_EMAIL']     unless ENV['NETSUITE_EMAIL'].nil?
-      password      ENV['NETSUITE_PASSWORD']  unless ENV['NETSUITE_PASSWORD'].nil?
-      account       ENV['NETSUITE_ACCOUNT']   unless ENV['NETSUITE_ACCOUNT'].nil?
-      role          ENV['NETSUITE_ROLE']      unless ENV['NETSUITE_ROLE'].nil?
-      api_version   ENV['NETSUITE_API']       unless ENV['NETSUITE_API'].nil?
-      sandbox       (ENV['NETSUITE_PRODUCTION'].nil? || ENV['NETSUITE_PRODUCTION'] != 'true')
-      wsdl          ENV['NETSUITE_WSDL']      unless ENV['NETSUITE_WSDL'].nil?
-      silent        (!ENV['NETSUITE_SILENT'].nil? && ENV['NETSUITE_SILENT'] == 'true')
-
-      read_timeout  100_000
-    end
-
-    self.configure(&block) if block
-  end
-
 end