netsuite-soap 2025.2.3

data/spec/netsuite/records/service_sale_item_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe NetSuite::Records::ServiceSaleItem do
+  let(:item) { NetSuite::Records::ServiceSaleItem.new }
+
+  it 'has the right fields' do
+    [
+      :available_to_partners, :cost_estimate, :cost_estimate_type, :cost_estimate_units, :create_job, :created_date,
+      :display_name, :dont_show_price, :enforce_min_qty_internally, :exclude_from_sitemap, :featured_description,
+      :include_children, :is_donation_item, :is_fulfillable, :is_gco_compliant, :is_inactive, :is_online, :is_taxable,
+      :item_id, :last_modified_date, :matrix_option_list, :matrix_type, :max_donation_amount, :meta_tag_html,
+      :minimum_quantity, :minimum_quantity_units, :no_price_message, :offer_support, :on_special, :out_of_stock_behavior,
+      :out_of_stock_message, :overall_quantity_pricing_type, :page_title, :presentation_item_list, :prices_include_tax,
+      :rate, :related_items_description, :sales_description, :search_keywords,
+      :show_default_donation_amount, :site_category_list, :sitemap_priority, :soft_descriptor, :specials_description,
+      :store_description, :store_detailed_description, :store_display_name, :translations_list, :upc_code, :url_component,
+      :use_marginal_rates, :vsoe_deferral, :vsoe_delivered, :vsoe_permit_discount, :vsoe_price, :vsoe_sop_group
+    ].each do |field|
+      expect(item).to have_field(field)
+    end
+
+    # TODO there is a probably a more robust way to test this
+    expect(item.custom_field_list.class).to eq(NetSuite::Records::CustomFieldList)
+    expect(item.pricing_matrix.class).to eq(NetSuite::Records::PricingMatrix)
+    expect(item.subsidiary_list.class).to eq(NetSuite::Records::RecordRefList)
+  end
+
+  it 'has the right record_refs' do
+    [
+      :billing_schedule, :cost_category, :custom_form, :deferred_revenue_account, :department, :income_account,
+      :issue_product, :item_options_list, :klass, :location, :parent, :pricing_group, :purchase_tax_code,
+      :quantity_pricing_schedule, :rev_rec_schedule, :sale_unit, :sales_tax_code, :store_display_image,
+      :store_display_thumbnail, :store_item_template, :tax_schedule, :units_type
+    ].each do |record_ref|
+      expect(item).to have_record_ref(record_ref)
+    end
+  end
+
+  describe '.get' do
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :item_id => 'penguins' }) }
+
+      it 'returns a ServiceSaleItem instance populated with the data from the response object' do
+        expect(NetSuite::Actions::Get).to receive(:call).with([NetSuite::Records::ServiceSaleItem, :external_id => 20], {}).and_return(response)
+        customer = NetSuite::Records::ServiceSaleItem.get(:external_id => 20)
+        expect(customer).to be_kind_of(NetSuite::Records::ServiceSaleItem)
+        expect(customer.item_id).to eql('penguins')
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'raises a RecordNotFound exception' do
+        expect(NetSuite::Actions::Get).to receive(:call).with([NetSuite::Records::ServiceSaleItem, :external_id => 20], {}).and_return(response)
+        expect {
+          NetSuite::Records::ServiceSaleItem.get(:external_id => 20)
+        }.to raise_error(NetSuite::RecordNotFound,
+          /NetSuite::Records::ServiceSaleItem with OPTIONS=(.*) could not be found/)
+      end
+    end
+  end
+
+  describe '#add' do
+    # let(:item) { NetSuite::Records::ServiceSaleItem.new(:cost => 100, :is_inactive => false) }
+
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :internal_id => '1' }) }
+
+      it 'returns true' do
+        expect(NetSuite::Actions::Add).to receive(:call).
+            with([item], {}).
+            and_return(response)
+        expect(item.add).to be_truthy
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'returns false' do
+        expect(NetSuite::Actions::Add).to receive(:call).
+            with([item], {}).
+            and_return(response)
+        expect(item.add).to be_falsey
+      end
+    end
+  end
+
+  describe '#delete' do
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :internal_id => '1' }) }
+
+      it 'returns true' do
+        expect(NetSuite::Actions::Delete).to receive(:call).
+            with([item], {}).
+            and_return(response)
+        expect(item.delete).to be_truthy
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'returns false' do
+        expect(NetSuite::Actions::Delete).to receive(:call).
+            with([item], {}).
+            and_return(response)
+        expect(item.delete).to be_falsey
+      end
+    end
+  end
+
+  describe '#to_record' do
+    before do
+      item.item_id = 'penguins'
+      item.is_online     = true
+    end
+
+    it 'can represent itself as a SOAP record' do
+      record = {
+        'listAcct:itemId' => 'penguins',
+        'listAcct:isOnline'     => true
+      }
+      expect(item.to_record).to eql(record)
+    end
+  end
+
+  describe '#record_type' do
+    it 'returns a string of the SOAP type' do
+      expect(item.record_type).to eql('listAcct:ServiceSaleItem')
+    end
+  end
+
+end

data/spec/netsuite/records/ship_address_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe NetSuite::Records::ShipAddress do
+  let(:ship_address) { NetSuite::Records::ShipAddress.new }
+
+  it 'has all the right fields' do
+    [
+      :ship_attention, :ship_addressee, :ship_phone, :ship_addr1, :ship_addr2, :ship_addr3,
+      :ship_city, :ship_state, :ship_zip, :ship_country, :ship_is_residential
+    ].each do |field|
+      expect(ship_address).to have_field(field)
+    end
+  end
+
+  describe '#to_record' do
+    before do
+      ship_address.ship_attention = 'Mr. Smith'
+      ship_address.ship_zip       = '90007'
+    end
+
+    it 'can represent itself as a SOAP record' do
+      record = {
+        'platformCommon:shipAttention' => 'Mr. Smith',
+        'platformCommon:shipZip'       => '90007'
+      }
+      expect(ship_address.to_record).to eql(record)
+    end
+  end
+
+  describe '#record_type' do
+    it 'returns a string of the SOAP record type' do
+      expect(ship_address.record_type).to eql('platformCommon:ShipAddress')
+    end
+  end
+
+end

data/spec/netsuite/records/site_category_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe NetSuite::Records::SiteCategory do
+  let(:site_category) { NetSuite::Records::SiteCategory.new }
+
+  it 'has all the right fields' do
+    [
+      :description, :exclude_from_site_map, :is_inactive, :is_online,
+      :item_id, :meta_tag_html, :page_title, :presentation_item_list,
+      :search_keywords, :sitemap_priority, :store_detailed_description,
+      :translations_list, :url_component
+    ].each do |field|
+      expect(site_category).to have_field(field)
+    end
+  end
+
+  it 'has the right record_refs' do
+    [
+      :category_list_layout, :correlated_items_list_layout, :item_list_layout, :parent_category,
+      :related_items_list_layout, :store_display_image, :store_display_thumbnail, :website
+    ].each do |record_ref|
+      expect(site_category).to have_record_ref(record_ref)
+    end
+  end
+
+  describe '.get' do
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :url_component => 'some url' }) }
+
+      it 'returns a SiteCategory instance populated with the data from the response object' do
+        expect(NetSuite::Actions::Get).to receive(:call).with([NetSuite::Records::SiteCategory, :external_id => 1], {}).and_return(response)
+        site_category = NetSuite::Records::SiteCategory.get(:external_id => 1)
+        expect(site_category).to be_kind_of(NetSuite::Records::SiteCategory)
+        expect(site_category.url_component).to eq('some url')
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'raises a RecordNotFound exception' do
+        expect(NetSuite::Actions::Get).to receive(:call).with([NetSuite::Records::SiteCategory, :external_id => 1], {}).and_return(response)
+        expect {
+          NetSuite::Records::SiteCategory.get(:external_id => 1)
+        }.to raise_error(NetSuite::RecordNotFound,
+          /NetSuite::Records::SiteCategory with OPTIONS=(.*) could not be found/)
+      end
+    end
+  end
+
+end

data/spec/netsuite/records/subscription_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe NetSuite::Records::Subscription do
+
+  let(:attributes) do
+    {
+      :subscription => {
+        :subscribed          => true,
+        :subscription        => NetSuite::Records::RecordRef.new(internal_id: '123123', name: 'My Sub'),
+        :last_modified_date  => DateTime.new(2018, 1, 1, 0, 0, 0)
+      }
+    }
+  end
+
+  let(:list) { NetSuite::Records::Subscription.new(attributes) }
+
+  it 'has all the right fields' do
+    [
+      :subscribed, :last_modified_date
+    ].each do |field|
+      expect(list).to have_field(field)
+    end
+
+    expect(list.subscription).to_not be_nil
+  end
+
+  describe '#initialize' do
+    context 'when taking in a hash of attributes' do
+      it 'sets the attributes for the object given the attributes hash' do
+        expect(list.subscription.subscribed).to eql(true)
+        expect(list.subscription.subscription.internal_id).to eql('123123')
+        expect(list.subscription.subscription.name).to eql('My Sub')
+        expect(list.subscription.last_modified_date).to_not be_nil
+      end
+    end
+  end
+end

data/spec/netsuite/records/subscriptions_list_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe NetSuite::Records::SubscriptionsList do
+  let(:list) { NetSuite::Records::SubscriptionsList.new }
+
+  it 'has a subscriptions attribute' do
+    expect(list.subscriptions).to be_kind_of(Array)
+  end
+
+  describe '#to_record' do
+    it 'can represent itself as a SOAP record' do
+
+      record = {
+        'listRel:subscriptions' => []
+      }
+      expect(list.to_record).to eql(record)
+    end
+  end
+end

data/spec/netsuite/records/subsidiary_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe NetSuite::Records::Subsidiary do
+  let(:subsidiary) { described_class.new }
+
+  it 'has all the right fields' do
+    [ :name, :is_inactive, :show_subsidiary_name, :url, :tran_prefix, :attention,
+      :addressee, :addr_phone, :addr1, :addr2, :addr3, :city, :state, :zip,
+      :country, :addr_text, :override, :ship_addr, :return_addr, :return_address1,
+      :return_address2, :return_city, :return_state, :return_country, :return_zip,
+      :legal_name, :is_elimination, :allow_payroll, :email, :fax, :edition,
+      :federal_id_number, :addr_language, :non_consol, :consol, :ship_address1,
+      :ship_address2, :ship_city, :ship_state, :ship_country, :ship_zip,
+      :state1_tax_number, :ssn_or_tin, :inbound_email ].each do |field|
+      expect(subsidiary).to have_field(field)
+    end
+  end
+
+  it 'has all the right record refs' do
+    [ :check_layout, :inter_co_account, :parent, :logo, :page_logo,
+      :fiscal_calendar, :tax_fiscal_calendar, :currency ].each do |record_ref|
+      expect(subsidiary).to have_record_ref(record_ref)
+    end
+  end
+end

data/spec/netsuite/records/support_case_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+describe NetSuite::Records::SupportCase do
+  let(:support_case) { NetSuite::Records::SupportCase.new }
+
+  it 'has all the right fields' do
+    [
+      :end_date, :incoming_message, :outgoing_message, :search_solution, :email_form,
+      :internal_only, :title, :case_number, :start_date, :email, :phone, :inbound_email,
+      :is_inactive, :help_desk
+    ].each do |field|
+      expect(support_case).to have_field(field)
+    end
+  end
+
+  it 'has the right record_refs' do
+    [
+      :custom_form, :company, :contact, :issue, :status, :priority, :origin, :category, :assigned
+    ].each do |record_ref|
+      expect(support_case).to have_record_ref(record_ref)
+    end
+  end
+
+  describe '#custom_field_list' do
+    it 'can be set from attributes' do
+      attributes = {
+        :custom_field => {
+          :value => 10,
+          :internal_id => 'custfield_something'
+        }
+      }
+      support_case.custom_field_list = attributes
+      expect(support_case.custom_field_list).to be_kind_of(NetSuite::Records::CustomFieldList)
+      expect(support_case.custom_field_list.custom_fields.length).to eql(1)
+    end
+
+    it 'can be set from a CustomFieldList object' do
+      custom_field_list = NetSuite::Records::CustomFieldList.new
+      support_case.custom_field_list = custom_field_list
+      expect(support_case.custom_field_list).to eql(custom_field_list)
+    end
+  end
+
+  describe '.get' do
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :title => 'Case title' }) }
+
+      it 'returns a SupportCase instance populated with the data from the response object' do
+        expect(NetSuite::Actions::Get).to receive(:call).with([NetSuite::Records::SupportCase, :external_id => 1], {}).and_return(response)
+        support_case = NetSuite::Records::SupportCase.get(:external_id => 1)
+        expect(support_case).to be_kind_of(NetSuite::Records::SupportCase)
+        expect(support_case.title).to eq('Case title')
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'raises a RecordNotFound exception' do
+        expect(NetSuite::Actions::Get).to receive(:call).with([NetSuite::Records::SupportCase, :external_id => 1], {}).and_return(response)
+        expect {
+          NetSuite::Records::SupportCase.get(:external_id => 1)
+        }.to raise_error(NetSuite::RecordNotFound,
+          /NetSuite::Records::SupportCase with OPTIONS=(.*) could not be found/)
+      end
+    end
+  end
+
+  describe '#add' do
+    let(:support_case) { NetSuite::Records::SupportCase.new(:title => 'Case title') }
+
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :internal_id => '1' }) }
+
+      it 'returns true' do
+        expect(NetSuite::Actions::Add).to receive(:call).
+            with([support_case], {}).
+            and_return(response)
+        expect(support_case.add).to be_truthy
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'returns false' do
+        expect(NetSuite::Actions::Add).to receive(:call).
+            with([support_case], {}).
+            and_return(response)
+        expect(support_case.add).to be_falsey
+      end
+    end
+  end
+
+  describe '#delete' do
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :internal_id => '1' }) }
+
+      it 'returns true' do
+        expect(NetSuite::Actions::Delete).to receive(:call).
+            with([support_case], {}).
+            and_return(response)
+        expect(support_case.delete).to be_truthy
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'returns false' do
+        expect(NetSuite::Actions::Delete).to receive(:call).
+            with([support_case], {}).
+            and_return(response)
+        expect(support_case.delete).to be_falsey
+      end
+    end
+  end
+
+  describe '.update' do
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :title => 'Case title' }) }
+
+      it 'returns true' do
+        expect(NetSuite::Actions::Update).to receive(:call).with([NetSuite::Records::SupportCase, :external_id => 1, :title => 'Case title'], {}).and_return(response)
+        support_case = NetSuite::Records::SupportCase.new(:external_id => 1)
+        expect(support_case.update(:title => 'Case title')).to be_truthy
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'raises a RecordNotFound exception' do
+        expect(NetSuite::Actions::Update).to receive(:call).with([NetSuite::Records::SupportCase, :internal_id => 1, :title => 'Case title'], {}).and_return(response)
+        support_case = NetSuite::Records::SupportCase.new(:internal_id => 1)
+        expect(support_case.update(:title => 'Case title')).to be_falsey
+      end
+    end
+  end
+
+  describe '#to_record' do
+    let(:support_case) { NetSuite::Records::SupportCase.new(:title => 'Case title') }
+
+    it 'returns a hash of attributes that can be used in a SOAP request' do
+      expect(support_case.to_record).to eql({
+        'listSupport:title' => 'Case title'
+      })
+    end
+  end
+
+  describe '#record_type' do
+    it 'returns a string type for the record to be used in a SOAP request' do
+      expect(support_case.record_type).to eql('listSupport:SupportCase')
+    end
+  end
+
+end

data/spec/netsuite/records/support_case_type_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe NetSuite::Records::SupportCaseType do
+  let(:support_case_type) { NetSuite::Records::SupportCaseType.new }
+
+  it 'has all the right fields' do
+    [
+      :description, :is_inactive, :name
+    ].each do |field|
+      expect(support_case_type).to have_field(field)
+    end
+  end
+
+  it 'has the right record_refs' do
+    [
+      :insert_before
+    ].each do |record_ref|
+      expect(support_case_type).to have_record_ref(record_ref)
+    end
+  end
+
+end

data/spec/netsuite/records/tax_type_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe NetSuite::Records::TaxType do
+  subject(:tax_type) { described_class.new }
+
+  it 'has all the right fields' do
+    [ :description, :name ].each do |field|
+      expect(tax_type).to have_field(field)
+    end
+  end
+end

data/spec/netsuite/records/term_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe NetSuite::Records::Term do
+  let(:term) { NetSuite::Records::Term.new }
+
+  it 'has all the right fields' do
+    [
+      :name, :date_driven, :days_until_net_due, :discount_percent, :days_until_expiry, :day_of_month_net_due,
+      :due_next_month_if_within_days, :discount_percent_date_driven, :day_discount_expires, :preferred, :is_inactive
+    ].each do |field|
+      expect(term).to have_field(field)
+    end
+  end
+
+  describe '.get' do
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :name => 'Term 1' }) }
+
+      it 'returns a Term instance populated with the data from the response object' do
+        expect(NetSuite::Actions::Get).to receive(:call).with([NetSuite::Records::Term, {:external_id => 1}], {}).and_return(response)
+        term = NetSuite::Records::Term.get(:external_id => 1)
+        expect(term).to be_kind_of(NetSuite::Records::Term)
+        expect(term.name).to eql('Term 1')
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'raises a RecordNotFound exception' do
+        expect(NetSuite::Actions::Get).to receive(:call).with([NetSuite::Records::Term, {:external_id => 1}], {}).and_return(response)
+        expect {
+          NetSuite::Records::Term.get(:external_id => 1)
+        }.to raise_error(NetSuite::RecordNotFound,
+          /NetSuite::Records::Term with OPTIONS=(.*) could not be found/)
+      end
+    end
+  end
+
+  describe '#add' do
+    let(:test_data) { { :name => 'Test Term' } }
+
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :internal_id => '1' }) }
+
+      it 'returns true' do
+        term = NetSuite::Records::Term.new(test_data)
+        expect(NetSuite::Actions::Add).to receive(:call).
+            with([term], {}).
+            and_return(response)
+        expect(term.add).to be_truthy
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'returns false' do
+        term = NetSuite::Records::Term.new(test_data)
+        expect(NetSuite::Actions::Add).to receive(:call).
+            with([term], {}).
+            and_return(response)
+        expect(term.add).to be_falsey
+      end
+    end
+  end
+
+  describe '#delete' do
+    let(:test_data) { { :internal_id => '1' } }
+
+    context 'when the response is successful' do
+      let(:response)  { NetSuite::Response.new(:success => true, :body => { :internal_id => '1' }) }
+
+      it 'returns true' do
+        term = NetSuite::Records::Term.new(test_data)
+        expect(NetSuite::Actions::Delete).to receive(:call).
+            with([term], {}).
+            and_return(response)
+        expect(term.delete).to be_truthy
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'returns false' do
+        term = NetSuite::Records::Term.new(test_data)
+        expect(NetSuite::Actions::Delete).to receive(:call).
+            with([term], {}).
+            and_return(response)
+        expect(term.delete).to be_falsey
+      end
+    end
+  end
+
+end

data/spec/netsuite/records/transaction_body_custom_field_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe NetSuite::Records::TransactionBodyCustomField do
+  describe ".get" do
+    context "success" do
+      let(:internal_id) { 1 }
+      let(:response) do
+        NetSuite::Response.new(
+          success: true,
+          body: {
+            access_level: "_edit",
+            field_type: "_freeFormText",
+            label: "Billing System Subdomain",
+          }
+        )
+      end
+
+      it "returns a TransactionColumnCustomField instance with populated fields" do
+        expect(NetSuite::Actions::Get)
+          .to receive(:call)
+          .with([NetSuite::Records::TransactionBodyCustomField, internal_id: internal_id], {})
+          .and_return(response)
+
+        record = NetSuite::Records::TransactionBodyCustomField.get(internal_id: internal_id)
+
+        expect(record.access_level).to eql("_edit")
+        expect(record.field_type).to eql("_freeFormText")
+        expect(record.label).to eql("Billing System Subdomain")
+      end
+    end
+  end
+end

data/spec/netsuite/records/transaction_column_custom_field_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe NetSuite::Records::TransactionColumnCustomField do
+  describe ".get" do
+    context "success" do
+      let(:internal_id) { 1 }
+      let(:response) do
+        NetSuite::Response.new(
+          success: true,
+          body: { 
+            access_level: "_none",
+            field_type: "_decimalNumber",
+            label: "Billing System Tax",
+          }
+        )
+      end
+
+      it "returns a TransactionColumnCustomField instance with populated fields" do
+        expect(NetSuite::Actions::Get)
+          .to receive(:call)
+          .with([NetSuite::Records::TransactionColumnCustomField, internal_id: internal_id], {})
+          .and_return(response)
+
+        record = NetSuite::Records::TransactionColumnCustomField.get(internal_id: internal_id)
+
+        expect(record.access_level).to eql("_none")
+        expect(record.field_type).to eql("_decimalNumber")
+        expect(record.label).to eql("Billing System Tax")
+      end
+    end
+  end
+end