netsuite-soap 2025.2.3

data/spec/netsuite/records/customer_spec.rb

@@ -0,0 +1,561 @@
+require 'spec_helper'
+
+describe NetSuite::Records::Customer do
+  let(:customer) { NetSuite::Records::Customer.new }
+
+  it 'has all the right fields' do
+    [
+      :account_number,
+      :aging,
+      :aging1,
+      :aging2,
+      :aging3,
+      :aging4,
+      :alcohol_recipient_type,
+      :alt_email,
+      :alt_name,
+      :alt_phone,
+      :bill_pay,
+      :click_stream,
+      :comments,
+      :company_name,
+      :consol_aging,
+      :consol_aging1,
+      :consol_aging2,
+      :consol_aging3,
+      :consol_aging4,
+      :consol_days_overdue,
+      :contrib_pct,
+      :credit_hold_override,
+      :credit_limit,
+      :date_created,
+      :days_overdue,
+      :default_address,
+      :default_order_priority,
+      :display_symbol,
+      :email,
+      :email_preference,
+      :email_transactions,
+      :end_date,
+      :entity_id,
+      :estimated_budget,
+      :fax,
+      :fax_transactions,
+      :first_name,
+      :first_visit,
+      :give_access,
+      :global_subscription_status,
+      :home_phone,
+      :is_budget_approved,
+      :is_inactive,
+      :is_person,
+      :keywords,
+      :language,
+      :last_modified_date,
+      :last_name,
+      :last_page_visited,
+      :last_visit,
+      :middle_name,
+      :mobile_phone,
+      :monthly_closing,
+      :negative_number_format,
+      :number_format,
+      :opening_balance,
+      :opening_balance_date,
+      :override_currency_format,
+      :password,
+      :password2,
+      :phone,
+      :phonetic_name,
+      :print_on_check_as,
+      :print_transactions,
+      :referrer,
+      :reminder_days,
+      :require_pwd_change,
+      :resale_number,
+      :salutation,
+      :send_email,
+      :ship_complete,
+      :stage,
+      :start_date,
+      :symbol_placement,
+      :sync_partner_teams,
+      :taxable,
+      :tax_exempt,
+      :third_party_acct,
+      :third_party_country,
+      :third_party_zipcode,
+      :title,
+      :url,
+      :vat_reg_number,
+      :visits,
+      :web_lead,
+    ].each do |field|
+      expect(customer).to have_field(field)
+    end
+  end
+
+  it 'has all the right fields with specific classes' do
+    {
+      addressbook_list: NetSuite::Records::CustomerAddressbookList,
+      contact_roles_list: NetSuite::Records::ContactAccessRolesList,
+      credit_cards_list: NetSuite::Records::CustomerCreditCardsList,
+      currency_list: NetSuite::Records::CustomerCurrencyList,
+      custom_field_list: NetSuite::Records::CustomFieldList,
+      # download_list: NetSuite::Records::CustomerDownloadList, # TODO Implement me
+      # group_pricing_list: NetSuite::Records::CustomerGroupPricingList, # TODO: Implement me
+      # item_pricing_list: NetSuite::Records::CustomerItemPricingList, # TODO: Implement me
+      partners_list: NetSuite::Records::CustomerPartnersList,
+      sales_team_list: NetSuite::Records::CustomerSalesTeamList,
+      subscriptions_list: NetSuite::Records::SubscriptionsList,
+      # tax_registration_list: NetSuite::Records::CustomerTaxRegistrationList, # TODO: Implement me
+    }.each do |field, klass|
+      expect(customer).to have_field(field, klass)
+    end
+  end
+
+  it 'has all the right read_only_fields' do
+    [
+      :balance,
+      :consol_balance,
+      :deposit_balance,
+      :consol_deposit_balance,
+      :overdue_balance,
+      :consol_overdue_balance,
+      :unbilled_orders,
+      :consol_unbilled_orders,
+    ].each do |field|
+      expect(NetSuite::Records::Customer).to have_read_only_field(field)
+    end
+  end
+
+  it 'has all the right search_only_fields' do
+    [
+      :address,
+      :address1,
+      :address2,
+      :address3,
+      :addressee,
+      :address_internal_id,
+      :address_label,
+      :address_phone,
+      :alt_contact,
+      :assigned_site,
+      :assigned_site_id,
+      :attention,
+      :available_offline,
+      :bill_address,
+      :bill_address1,
+      :bill_address2,
+      :bill_address3,
+      :bill_addressee,
+      :bill_attention,
+      :bill_city,
+      :bill_country,
+      :bill_country_code,
+      :bill_phone,
+      :bill_state,
+      :bill_zip_code,
+      :cc_customer_code,
+      :cc_default,
+      :cc_exp_date,
+      :cc_holder_name,
+      :cc_internal_id,
+      :cc_number,
+      :cc_state,
+      :cc_state_from,
+      :cc_type,
+      :city,
+      :contact,
+      :contribution,
+      :contribution_primary,
+      :conversion_date,
+      :country,
+      :country_code,
+      :credit_hold,
+      :date_closed,
+      :entity_number,
+      :explicit_conversion,
+      :first_order_date,
+      :first_sale_date,
+      :fx_balance,
+      :fx_consol_balance,
+      :fx_consol_unbilled_orders,
+      :fx_unbilled_orders,
+      :group_pricing_level,
+      :has_duplicates,
+      :is_default_billing,
+      :is_default_shipping,
+      :is_ship_address,
+      :item_pricing_level,
+      :item_pricing_unit_price,
+      :job_end_date,
+      :job_projected_end,
+      :job_start_date,
+      :job_type,
+      :last_order_date,
+      :last_sale_date,
+      :lead_date,
+      :level,
+      :manual_credit_hold,
+      :on_credit_hold,
+      :partner_contribution,
+      :partner_role,
+      :partner_team_member,
+      :pec,
+      :permission,
+      :pricing_group,
+      :pricing_item,
+      :prospect_date,
+      :role,
+      :sales_team_member,
+      :sales_team_role,
+      :ship_address,
+      :ship_address1,
+      :ship_address2,
+      :ship_address3,
+      :ship_addressee,
+      :ship_attention,
+      :ship_city,
+      :ship_country,
+      :ship_country_code,
+      :ship_phone,
+      :ship_state,
+      :ship_zip,
+      :source_site,
+      :source_site_id,
+      :state,
+      :subscription,
+      :subscription_date,
+      :subscription_status,
+      :zip_code,
+    ].each do |field|
+      expect(NetSuite::Records::Customer).to have_search_only_field(field)
+    end
+  end
+
+  it 'has the right record_refs' do
+    [
+      :access_role,
+      :assigned_web_site,
+      :buying_reason,
+      :buying_time_frame,
+      :campaign_category,
+      :category,
+      :currency,
+      :custom_form,
+      :default_allocation_strategy,
+      :default_tax_reg,
+      :dr_account,
+      :entity_status,
+      :fx_account,
+      :image,
+      :lead_source,
+      :opening_balance_account,
+      :parent,
+      :partner,
+      :pref_cc_processor,
+      :price_level,
+      :receivables_account,
+      :representing_subsidiary,
+      :sales_group,
+      :sales_readiness,
+      :sales_rep,
+      :shipping_item,
+      :source_web_site,
+      :subsidiary,
+      :tax_item,
+      :terms,
+      :territory,
+    ].each do |record_ref|
+      expect(customer).to have_record_ref(record_ref)
+    end
+  end
+
+  # TODO test contact_roles_list
+
+  describe '#addressbook_list' do
+    it 'can be set from attributes' do
+      customer.addressbook_list = {
+        :addressbook => {
+          :addr1            => '123 Happy Lane',
+          :addr_text        => "123 Happy Lane\nLos Angeles CA 90007",
+          :city             => 'Los Angeles',
+          :country          => '_unitedStates',
+          :default_billing  => true,
+          :default_shipping => true,
+          :internal_id      => '567',
+          :is_residential   => false,
+          :label            => '123 Happy Lane',
+          :override         => false,
+          :state            => 'CA',
+          :zip              => '90007'
+        }
+      }
+      expect(customer.addressbook_list).to be_kind_of(NetSuite::Records::CustomerAddressbookList)
+      expect(customer.addressbook_list.addressbook.length).to eql(1)
+    end
+
+    it 'can be set from a CustomerAddressbookList object' do
+      customer_addressbook_list = NetSuite::Records::CustomerAddressbookList.new
+      customer.addressbook_list = customer_addressbook_list
+      expect(customer.addressbook_list).to eql(customer_addressbook_list)
+    end
+  end
+
+  describe '#credit_cards_list' do
+    it 'can be set from attributes' do
+      customer.credit_cards_list = {
+        :credit_cards => {
+          :internal_id       => '1234567',
+          :cc_default        => true,
+          :cc_expire_date    => '2099-12-01T00:00:00.000-08:00'
+        }
+      }
+
+      expect(customer.credit_cards_list).to be_kind_of(NetSuite::Records::CustomerCreditCardsList)
+      expect(customer.credit_cards_list.credit_cards.length).to eql(1)
+    end
+
+    it 'can be set from a CustomerCreditCardsList object' do
+      customer_credit_cards_list = NetSuite::Records::CustomerCreditCardsList.new
+      customer.credit_cards_list = customer_credit_cards_list
+      expect(customer.credit_cards_list).to eql(customer_credit_cards_list)
+    end
+  end
+
+  describe '#custom_field_list' do
+    it 'can be set from attributes' do
+      attributes = {
+        :custom_field => {
+          :value => 10,
+          :internal_id => 'custfield_something'
+        }
+      }
+      customer.custom_field_list = attributes
+      expect(customer.custom_field_list).to be_kind_of(NetSuite::Records::CustomFieldList)
+      expect(customer.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
+      customer.custom_field_list = custom_field_list
+      expect(customer.custom_field_list).to eql(custom_field_list)
+    end
+  end
+
+  describe '#subscriptions_list' do
+    it 'can be set from attributes' do
+      customer.subscriptions_list = {
+        subscriptions: [
+          {
+            :subscribed         => true
+          }
+        ]
+      }
+      expect(customer.subscriptions_list).to be_kind_of(NetSuite::Records::SubscriptionsList)
+      expect(customer.subscriptions_list.subscriptions.length).to eql(1)
+    end
+
+    it 'can be set from a SubscriptionsList object' do
+      customer_subscriptions_list = NetSuite::Records::SubscriptionsList.new
+      customer.subscriptions_list = customer_subscriptions_list
+      expect(customer.subscriptions_list).to eql(customer_subscriptions_list)
+    end
+  end
+
+
+  describe '.get' do
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :is_person => true }) }
+
+      it 'returns a Customer instance populated with the data from the response object' do
+        expect(NetSuite::Actions::Get).to receive(:call).with([NetSuite::Records::Customer, {:external_id => 1}], {}).and_return(response)
+        customer = NetSuite::Records::Customer.get(:external_id => 1)
+        expect(customer).to be_kind_of(NetSuite::Records::Customer)
+        expect(customer.is_person).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::Get).to receive(:call).with([NetSuite::Records::Customer, {:external_id => 1}], {}).and_return(response)
+        expect {
+          NetSuite::Records::Customer.get(:external_id => 1)
+        }.to raise_error(NetSuite::RecordNotFound,
+          /NetSuite::Records::Customer with OPTIONS=(.*) could not be found/)
+      end
+    end
+  end
+
+  describe '#add' do
+    let(:customer) { NetSuite::Records::Customer.new(:entity_id => 'TEST CUSTOMER', :is_person => true) }
+
+    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([customer], {}).
+            and_return(response)
+        expect(customer.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([customer], {}).
+            and_return(response)
+        expect(customer.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([customer], {}).
+            and_return(response)
+        expect(customer.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([customer], {}).
+            and_return(response)
+        expect(customer.delete).to be_falsey
+      end
+    end
+  end
+
+  describe '#attach_file' do
+    let(:test_data) { { :email => 'test@example.com', :fax => '1234567890' } }
+    let(:file) { double('file') }
+
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :internal_id => '1' }) }
+
+      it 'returns true' do
+        customer = NetSuite::Records::Customer.new(test_data)
+        expect(NetSuite::Actions::AttachFile).to receive(:call).
+          with([customer, file], {}).
+          and_return(response)
+        expect(customer.attach_file(file)).to be_truthy
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'returns false' do
+        customer = NetSuite::Records::Customer.new(test_data)
+        expect(NetSuite::Actions::AttachFile).to receive(:call).
+          with([customer, file], {}).
+          and_return(response)
+        expect(customer.attach_file(file)).to be_falsey
+      end
+    end
+  end
+
+  describe '#to_record' do
+    let(:customer) { NetSuite::Records::Customer.new(:entity_id => 'TEST CUSTOMER', :is_person => true) }
+
+    it 'returns a hash of attributes that can be used in a SOAP request' do
+      expect(customer.to_record).to eql({
+        'listRel:entityId' => 'TEST CUSTOMER',
+        'listRel:isPerson' => true
+      })
+    end
+  end
+
+  describe '#record_type' do
+    it 'returns a string type for the record to be used in a SOAP request' do
+      expect(customer.record_type).to eql('listRel:Customer')
+    end
+  end
+
+  describe '.upsert_list' do
+    before { savon.mock! }
+    after { savon.unmock! }
+
+    context 'with one customer' do
+      before do
+        savon.expects(:upsert_list).with(:message =>
+          {
+            'record' => [{
+              'listRel:entityId'    => 'Target',
+              'listRel:companyName' => 'Target',
+              '@xsi:type' => 'listRel:Customer',
+              '@externalId' => 'ext2'
+            }]
+        }).returns(File.read('spec/support/fixtures/upsert_list/upsert_list_one_customer.xml'))
+      end
+
+      it 'returns collection with one Customer instances populated with the data from the response object' do
+        customers = NetSuite::Records::Customer.upsert_list([
+          {
+            external_id: 'ext2',
+            entity_id: 'Target',
+            company_name: 'Target'
+          }
+        ])
+        shutter_fly = customers[0]
+        expect(shutter_fly).to be_kind_of(NetSuite::Records::Customer)
+        expect(shutter_fly.entity_id).to eq('Target')
+        expect(shutter_fly.internal_id).to eq('974')
+      end
+    end
+
+    context 'with two customers' do
+      before do
+        savon.expects(:upsert_list).with(:message =>
+          {
+            'record' => [{
+                'listRel:entityId'    => 'Shutter Fly',
+                'listRel:companyName' => 'Shutter Fly, Inc.',
+                '@xsi:type' => 'listRel:Customer',
+                '@externalId' => 'ext1'
+              },
+              {
+                'listRel:entityId'    => 'Target',
+                'listRel:companyName' => 'Target',
+                '@xsi:type' => 'listRel:Customer',
+                '@externalId' => 'ext2'
+              }
+            ]
+        }).returns(File.read('spec/support/fixtures/upsert_list/upsert_list_customers.xml'))
+      end
+
+      it 'returns collection of Customer instances populated with the data from the response object' do
+        customers = NetSuite::Records::Customer.upsert_list([
+          {
+            external_id: 'ext1',
+            entity_id: 'Shutter Fly',
+            company_name: 'Shutter Fly, Inc.'
+          },
+          {
+            external_id: 'ext2',
+            entity_id: 'Target',
+            company_name: 'Target'
+          }
+        ])
+        shutter_fly = customers[0]
+        expect(shutter_fly).to be_kind_of(NetSuite::Records::Customer)
+        expect(shutter_fly.entity_id).to eq('Shutter Fly')
+        expect(shutter_fly.internal_id).to eq('970')
+      end
+    end
+  end
+end

data/spec/netsuite/records/department_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe NetSuite::Records::Department do
+  let(:department) { NetSuite::Records::Department.new }
+
+  it 'has all the right fields' do
+    [
+      :name, :is_inactive
+    ].each do |field|
+      expect(department).to have_field(field)
+    end
+  end
+
+  it 'has all the right record refs' do
+    [
+      :parent
+    ].each do |record_ref|
+      expect(department).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 => { :name => 'Department 1' }) }
+
+      it 'returns a Department instance populated with the data from the response object' do
+        expect(NetSuite::Actions::Get).to receive(:call).with([NetSuite::Records::Department, {:external_id => 1}], {}).and_return(response)
+        department = NetSuite::Records::Department.get(:external_id => 1)
+        expect(department).to be_kind_of(NetSuite::Records::Department)
+        expect(department.name).to eql('Department 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::Department, {:external_id => 1}], {}).and_return(response)
+        expect {
+          NetSuite::Records::Department.get(:external_id => 1)
+        }.to raise_error(NetSuite::RecordNotFound,
+          /NetSuite::Records::Department with OPTIONS=(.*) could not be found/)
+      end
+    end
+  end
+
+  describe '#add' do
+    let(:test_data) { { :acct_name => 'Test Department', :description => 'An example Department' } }
+
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :internal_id => '1' }) }
+
+      it 'returns true' do
+        department = NetSuite::Records::Department.new(test_data)
+        expect(NetSuite::Actions::Add).to receive(:call).
+            with([department], {}).
+            and_return(response)
+        expect(department.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
+        department = NetSuite::Records::Department.new(test_data)
+        expect(NetSuite::Actions::Add).to receive(:call).
+            with([department], {}).
+            and_return(response)
+        expect(department.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
+        department = NetSuite::Records::Department.new(test_data)
+        expect(NetSuite::Actions::Delete).to receive(:call).
+            with([department], {}).
+            and_return(response)
+        expect(department.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
+        department = NetSuite::Records::Department.new(test_data)
+        expect(NetSuite::Actions::Delete).to receive(:call).
+            with([department], {}).
+            and_return(response)
+        expect(department.delete).to be_falsey
+      end
+    end
+  end
+
+end