Cld 1835 netsuite null fields

Gemfile

@@ -5,6 +5,7 @@ gem 'simplecov', :require => false
 
 gem 'pry-nav'
 gem 'pry-rescue'
+gem 'pry'
 
 # optional dependency for more accurate timezone conversion
 gem 'tzinfo', '1.2.5'

README.md

@@ -591,3 +591,23 @@ states.to_array.first[:get_all_response][:get_all_result][:record_list][:record]
 # About SuiteSync
 
 [SuiteSync, the Stripe-NetSuite integration](http://suitesync.io) uses this gem and funds the majority of it's development and maintenance.
+
+
+
+
+# Cloudsnap Additions
+
+I generally refer to the Netsuite Schema Browser as a source of truth over the actions, records, and fields that you see in this gem.  That documentation can be found here: https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2018_1/schema/record/account.html?mode=package
+
+**One note is to be mindful of the version that you are looking at in the schema browser and the version that you are using when you configure the netsuite credentials.
+
+### Actions
+attach.rb-->  lib/netsuite/actions/attach.rb
+Based on the Netsuite Schema documentation, we added in the attach action functionality.  This is primarily used to attach records considered File Cabinate
+
+
+### Records
+If you see the record in the netsuite schema browser, you can easily add it to the records in this gem.  Use the fields and sub lists mentioned in the Netsuite schema browser to build out the record file following the same format as the other record files.
+
+### Other Cloudsnap Changes
+We made a few changes to the configuration.rb file.  The check credentials method and set attributes methods were added to support the updated way of passing credentials.  In the connection method, we also added the ability to set the wsdl and the endpoint level for the Savon client that is configured.  This was required to connect to Netsuite api versions 2020+

lib/netsuite.rb

@@ -49,6 +49,7 @@ module Support
 
   module Actions
     autoload :Add,              'netsuite/actions/add'
+    autoload :Attach,           'netsuite/actions/attach'
     autoload :Delete,           'netsuite/actions/delete'
     autoload :DeleteList,       'netsuite/actions/delete_list'
     autoload :Get,              'netsuite/actions/get'
@@ -74,6 +75,7 @@ module Records
     autoload :Account,                          'netsuite/records/account'
     autoload :AccountingPeriod,                 'netsuite/records/accounting_period'
     autoload :Address,                          'netsuite/records/address'
+    autoload :AttachBasicReference,             'netsuite/records/attach_basic_reference'
     autoload :BaseRefList,                      'netsuite/records/base_ref_list'
     autoload :BillAddress,                      'netsuite/records/bill_address'
     autoload :BillingSchedule,                  'netsuite/records/billing_schedule'
@@ -156,8 +158,16 @@ module Records
     autoload :DescriptionItem,                  'netsuite/records/description_item'
     autoload :DiscountItem,                     'netsuite/records/discount_item'
     autoload :Duration,                         'netsuite/records/duration'
+    autoload :EmployeeAddressbookList,          'netsuite/records/employee_addressbook_list'
+    autoload :EmployeeAddressbook,              'netsuite/records/employee_addressbook'
     autoload :Employee,                         'netsuite/records/employee'
     autoload :EntityCustomField,                'netsuite/records/entity_custom_field'
+    autoload :ExpenseCategory,                  'netsuite/records/expense_category'
+    autoload :ExpenseCategoryRate,              'netsuite/records/expense_category_rate'
+    autoload :ExpenseCategoryRatesList,         'netsuite/records/expense_category_rates_list'
+    autoload :ExpenseReport,                    'netsuite/records/expense_report'
+    autoload :ExpenseReportExpense,             'netsuite/records/expense_report_expense'
+    autoload :ExpenseReportExpenseList,         'netsuite/records/expense_report_expense_list'
     autoload :File,                             'netsuite/records/file'
     autoload :GiftCertificate,                  'netsuite/records/gift_certificate'
     autoload :GiftCertificateItem,              'netsuite/records/gift_certificate_item'
@@ -195,6 +205,8 @@ module Records
     autoload :ItemMember,                       'netsuite/records/item_member'
     autoload :ItemMemberList,                   'netsuite/records/item_member_list'
     autoload :ItemReceipt,                      'netsuite/records/item_receipt'
+    autoload :ItemReceiptExpenseList,           'netsuite/records/item_receipt_expense_list'
+    autoload :ItemReceiptExpense,               'netsuite/records/item_receipt_expense'
     autoload :ItemReceiptItemList,              'netsuite/records/item_receipt_item_list'
     autoload :ItemReceiptItem,                  'netsuite/records/item_receipt_item'
     autoload :ItemVendor,                       'netsuite/records/item_vendor'
@@ -217,6 +229,7 @@ module Records
     autoload :NonInventoryResaleItem,           'netsuite/records/non_inventory_resale_item'
     autoload :Note,                             'netsuite/records/note'
     autoload :NoteType,                         'netsuite/records/note_type'
+    autoload :NullFieldList,                    'netsuite/records/null_field_list'
     autoload :Opportunity,                      'netsuite/records/opportunity'
     autoload :OpportunityItem,                  'netsuite/records/opportunity_item'
     autoload :OpportunityItemList,              'netsuite/records/opportunity_item_list'
@@ -235,6 +248,8 @@ module Records
     autoload :PromotionsList,                   'netsuite/records/promotions_list'
     autoload :Promotions,                       'netsuite/records/promotions'
     autoload :PurchaseOrder,                    'netsuite/records/purchase_order'
+    autoload :PurchaseOrderExpenseList,         'netsuite/records/purchase_order_expense_list'
+    autoload :PurchaseOrderExpense,             'netsuite/records/purchase_order_expense'
     autoload :PurchaseOrderItemList,            'netsuite/records/purchase_order_item_list'
     autoload :PurchaseOrderItem,                'netsuite/records/purchase_order_item'
     autoload :Roles,                            'netsuite/records/roles'
@@ -252,6 +267,7 @@ module Records
     autoload :SalesOrderItemList,               'netsuite/records/sales_order_item_list'
     autoload :SalesRole,                        'netsuite/records/sales_role'
     autoload :SalesTaxItem,                     'netsuite/records/sales_tax_item'
+    autoload :ServicePurchaseItem,              'netsuite/records/service_purchase_item'
     autoload :ServiceResaleItem,                'netsuite/records/service_resale_item'
     autoload :ServiceSaleItem,                  'netsuite/records/service_sale_item'
     autoload :SerializedAssemblyItem,          'netsuite/records/serialized_assembly_item'

lib/netsuite/actions/add.rb

@@ -73,11 +73,10 @@ def errors
       module Support
         def add(credentials={})
           response = NetSuite::Actions::Add.call([self], credentials)
-
           @errors = response.errors
 
           if response.success?
-            @internal_id = response.body[:@internal_id]
+            @internal_id = response.body.dig(:@internal_id) unless response.body.class == Nori::StringIOFile
             true
           else
             false

lib/netsuite/actions/attach.rb

@@ -0,0 +1,87 @@
+module NetSuite
+  module Actions
+    class Attach
+      include Support::Requests
+
+      attr_reader :response_hash
+
+      def initialize(object=nil)
+        @object = object
+      end
+
+      private
+
+      def request(credentials={})
+        NetSuite::Configuration.connection({}, credentials).call(:attach, :message => request_body)
+      end
+
+      #please note, reference is spelled referece and is documented that way in NetSuite's documentation
+      # <soap:Body>
+      #   <platformMsgs:attach>
+      #     <platformMsgs:attachReferece xsi:type="platformCore:AttachBasicReference">
+      #       <platformCore:attachTo internalId="443" type="vendorBill" xsi:type="platformCore:RecordRef"/>
+      #       <platformCore:attachedRecord type="file" internalId="353" xsi:type="platformCore:RecordRef"/>
+      #     </platformMsgs:attachReferece>
+      #   </platformMsgs:attach>
+      # </soap:Body>
+
+      def request_body
+        hash = {
+          'platformMsgs:attachReferece' => {
+            :content! => @object.to_record,
+            '@xsi:type' => @object.record_type
+          }
+        }
+        #not crazy about this solution but not sure how else to get the 'xsi:type' var in the hash
+        hash["platformMsgs:attachReferece"][:content!][:attributes!]["platformCore:attachTo"]["xsi:type"] = "platformCore:RecordRef"
+        hash["platformMsgs:attachReferece"][:content!][:attributes!]["platformCore:attachedRecord"]["xsi:type"] = "platformCore:RecordRef"
+
+        hash
+      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 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(credentials={})
+          response = NetSuite::Actions::Attach.call([self], credentials)
+
+          @errors = response.errors
+
+          if response.success?
+            @internal_id = response.body[:@internal_id]
+            true
+          else
+            false
+          end
+        end
+      end
+
+
+    end
+  end
+end

lib/netsuite/actions/get.rb

@@ -56,6 +56,17 @@ def response_hash
         @response_hash = @response.body[:get_response][:read_response]
       end
 
+      def response_errors
+        if response_hash[:status] && response_hash[:status][:status_detail]
+          @response_errors ||= errors
+        end
+      end
+
+      def errors
+        error_obj = response_hash.dig(:status,:status_detail)
+        OpenStruct.new(status: 404, status_detail: error_obj)
+      end
+
       module Support
 
         def self.included(base)
@@ -71,7 +82,7 @@ def get(options = {}, credentials = {})
             if response.success?
              new(response.body)
             else
-             raise RecordNotFound, "#{self} with OPTIONS=#{options.inspect} could not be found"
+              raise RecordNotFound, "#{self} with OPTIONS=#{options.inspect} could not be found, NetSuite message: #{response.errors.status_detail[:message]}"
             end
           end
 

lib/netsuite/actions/get_select_value.rb

@@ -47,7 +47,6 @@ def get_select_value(options = {}, credentials={})
             }
 
             response = NetSuite::Actions::GetSelectValue.call([self, message], credentials)
-
             if response.success?
               new(response.body)
             else

lib/netsuite/actions/update.rb

@@ -36,6 +36,12 @@ def request_body
           hash['platformMsgs:record']['@platformMsgs:externalId'] = updated_record.external_id
         end
 
+        inner = hash.dig("platformMsgs:record", :content!)
+        if inner.keys.grep(/(.*):nullFieldList?/).any?
+          null_field_key = inner.keys.grep(/(.*):nullFieldList?/)
+          hash["platformMsgs:record"][:content!]["platformCore:nullFieldList"] = hash["platformMsgs:record"][:content!].delete null_field_key[0]
+        end
+
         hash
       end
 

lib/netsuite/configuration.rb

@@ -15,6 +15,8 @@ def attributes
     end
 
     def connection(params={}, credentials={})
+      check_credentials(credentials)
+
       client = Savon.client({
         wsdl: cached_wsdl || wsdl,
         read_timeout: read_timeout,
@@ -27,10 +29,28 @@ def connection(params={}, credentials={})
         log_level: log_level,
         log: !silent, # turn off logging entirely if configured
       }.update(params))
+      client.wsdl.endpoint = client.wsdl.endpoint.to_s.sub('//webservices.netsuite.com/', "//#{wsdl_domain}/")
       cache_wsdl(client)
       return client
     end
 
+    def check_credentials(creds)
+      if !creds.blank?
+        set_attributes(creds)
+      end
+    end
+
+    def set_attributes(credentials)
+      account(credentials[:account])
+      consumer_key(credentials[:consumer_key])
+      consumer_secret(credentials[:consumer_secret])
+      token_id(credentials[:token_id])
+      token_secret(credentials[:token_secret])
+      api_version(credentials[:api_version])
+      wsdl_domain(credentials[:wsdl_domain])
+      soap_header(credentials[:soap_header])
+    end
+
     def filters(list = nil)
       if list
         self.filters = list
@@ -323,7 +343,7 @@ def read_timeout(timeout = nil)
       if timeout
         self.read_timeout = timeout
       else
-        attributes[:read_timeout] ||= 60
+        attributes[:read_timeout] ||= 120
       end
     end
 

lib/netsuite/records/account.rb

@@ -16,6 +16,8 @@ class Account
 
       field :subsidiary_list, RecordRefList
 
+      field :custom_field_list, CustomFieldList
+
       attr_reader :internal_id
       attr_accessor :external_id
       attr_accessor :search_joins

lib/netsuite/records/accounting_period.rb

@@ -8,7 +8,7 @@ class AccountingPeriod
 
       actions :get, :get_list, :add, :delete, :upsert, :search
 
-      fields :allow_non_gl_changes, :end_date, :is_adjust, :is_quarter, :is_year, :period_name, :start_date
+      fields :allow_non_gl_changes, :end_date, :is_adjust, :is_quarter, :is_year, :period_name, :start_date, :all_locked, :ap_locked, :ar_locked, :closed, :closed_on_date, :payroll_locked
 
       record_refs :parent
 

lib/netsuite/records/attach_basic_reference.rb

@@ -0,0 +1,20 @@
+module NetSuite
+  module Records
+    class AttachBasicReference
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Support::Actions
+      include Namespaces::PlatformCore
+
+      actions :attach
+
+      record_refs :attach_to, :attached_record
+
+      def initialize(attributes = {})
+        initialize_from_attributes_hash(attributes)
+      end
+
+    end
+  end
+end

lib/netsuite/records/contact.rb

@@ -17,6 +17,7 @@ class Contact
       field :custom_field_list, CustomFieldList
       # field :subscriptions_list, SubscriptionsList
       # field :category_list, CategoryList
+      field :null_field_list,   NullFieldList
 
       read_only_fields :last_modified_date, :date_created
 

lib/netsuite/records/credit_memo.rb

@@ -23,6 +23,7 @@ class CreditMemo
       field :item_list,                CreditMemoItemList
       field :apply_list,               CreditMemoApplyList
       field :ship_group_list,          SalesOrderShipGroupList
+      field :null_field_list,          NullFieldList
 
       # field :bill_address_list,
       field :transaction_bill_address, BillAddress

lib/netsuite/records/custom_field_list.rb

@@ -113,12 +113,15 @@ def extract_custom_field(custom_field_data)
             if type == "platformCore:SelectCustomFieldRef"
               attrs[:value] = CustomRecordRef.new(custom_field_data[:value])
             elsif type == 'platformCore:MultiSelectCustomFieldRef'
-              attrs[:value] = custom_field_data[:value].map do |entry|
-                CustomRecordRef.new(entry)
+              # if only one value of multiselect is selected it will be a hash, not an array
+              if attrs[:value].is_a?(Array)
+                attrs[:value] = custom_field_data[:value].map { |entry| CustomRecordRef.new(entry) }
+              else
+                attrs[:value] = CustomRecordRef.new(custom_field_data[:value])
               end
             end
-
             custom_fields << CustomField.new(attrs)
+
           end
         end
 

lib/netsuite/records/customer.rb

@@ -35,6 +35,7 @@ class Customer
       field :partners_list, CustomerPartnersList
       field :subscriptions_list, CustomerSubscriptionsList
       field :sales_team_list, CustomerSalesTeamList
+      field :null_field_list,   NullFieldList
 
       read_only_fields :balance, :consol_balance, :deposit_balance, :consol_deposit_balance, :overdue_balance,
         :consol_overdue_balance, :unbilled_orders, :consol_unbilled_orders

lib/netsuite/records/customer_payment.rb

@@ -17,6 +17,7 @@ class CustomerPayment
 
       field :custom_field_list, CustomFieldList
       field :apply_list,        CustomerPaymentApplyList
+      field :null_field_list,   NullFieldList
 
       read_only_fields :applied, :balance, :pending, :total, :unapplied