netsuite-soap 2025.2.3

data/spec/netsuite/actions/search_spec.rb

@@ -0,0 +1,387 @@
+require 'spec_helper'
+
+describe NetSuite::Actions::Search do
+  before(:all) { savon.mock! }
+  after(:all) { savon.unmock! }
+
+  it "handles custom auth credentials" do
+    credentials = {
+      email: 'fake@domain.com',
+      password: 'fake'
+    }
+
+    connection = NetSuite::Configuration.connection({}, credentials)
+
+    soap_header = {
+      "platformMsgs:passport"=>{
+        "platformCore:email"=>"fake@domain.com",
+        "platformCore:password"=>"fake",
+        "platformCore:account"=>"1234",
+        "platformCore:role"=>{:@internalId=>"3"}
+      }
+    }
+
+    expect(connection.instance_variable_get('@globals')[:soap_header]).to eq soap_header
+
+    allow(NetSuite::Configuration).to receive(:connection).and_return(double().as_null_object)
+
+    NetSuite::Records::Customer.search({}, credentials)
+
+    expect(NetSuite::Configuration).to have_received(:connection).with({}, credentials, { "platformMsgs:SearchPreferences"=>{} })
+  end
+
+  context "search class name" do
+    it "infers class name if class doesn't specify search class" do
+      instance = described_class.new NetSuite::Records::Customer
+      expect(instance.class_name).to eq "Customer"
+    end
+
+    it "gets class name from search class specified" do
+      instance = described_class.new NetSuite::Records::InventoryItem
+      expect(instance.class_name).to eq NetSuite::Records::InventoryItem.search_class_name
+    end
+  end
+
+  context "saved search" do
+    context "with no params" do
+      before do
+        savon.expects(:search).with(:message => {
+          'searchRecord' => {
+            '@xsi:type'           => 'listRel:CustomerSearchAdvanced',
+            '@savedSearchId'      => 500,
+            :content!             => { "listRel:criteria" => {} }
+          },
+        }).returns(File.read('spec/support/fixtures/search/saved_search_customer.xml'))
+      end
+
+      it "should handle a ID only search" do
+        result = NetSuite::Records::Customer.search(saved: 500)
+        expect(result.results.size).to eq(1)
+        expect(result.results.first.email).to eq('aemail@gmail.com')
+      end
+
+      it "merges preferences gracefully" do
+        expect {
+            NetSuite::Records::Customer.search(
+              saved: 500,
+              preferences: { page_size: 20 }
+            )
+        }.not_to raise_error
+      end
+    end
+
+
+    it "should handle a search with joined params containing custom field search" do
+      savon.expects(:search).with(:message => {
+        'searchRecord' => {
+          '@xsi:type'           => 'listRel:CustomerSearchAdvanced',
+          '@savedSearchId'      => 500,
+          :content!             => {
+            "listRel:criteria" => {
+              "listRel:basic" => {
+                "platformCommon:entityId" => {
+                  :content! => {"platformCore:searchValue" => "New Keywords"},
+                  :"@operator" => "hasKeywords"
+                },
+                "platformCommon:stage" => {
+                  :content! => {"platformCore:searchValue"=>["_lead", "_customer"]},
+                  :"@operator" => "anyOf"
+                },
+                "platformCommon:customFieldList" => {
+                  "platformCore:customField" => [
+                    {
+                      "platformCore:searchValue" => [{:"@internalId" => 4}, {:"@internalId" => 11}],
+                      :attributes! => {
+                        "platformCore:searchValue" => { "internalId" => [4, 11] }
+                      }
+                    },
+                    {
+                      "platformCore:searchValue" => [{}],
+                      :attributes! => {
+                        "platformCore:searchValue" => { "internalId" => [88825] }
+                      }
+                    }
+                  ],
+
+                  :attributes! => {
+                    "platformCore:customField" => {
+                      "scriptId" => ["custentity_customerandcontacttypelist", "custentity_relatedthing"],
+                      "operator" => ["anyOf", "anyOf"],
+                      "xsi:type" => ["platformCore:SearchMultiSelectCustomField", "platformCore:SearchMultiSelectCustomField"]
+                    }
+                  }
+                }
+              }
+            },
+            "listRel:columns" => [
+              {"tranSales:basic"=>{"platformCommon:internalId/"=>{}}}
+            ],
+          }
+        },
+      }).returns(File.read('spec/support/fixtures/search/saved_search_joined_custom_customer.xml'))
+
+      search = NetSuite::Records::Customer.search({
+        criteria: {
+          saved: 500,
+          basic: [
+            {
+              field: 'entityId',
+              value: 'New Keywords',
+              operator: 'hasKeywords'
+            },
+            {
+              field: 'stage',
+              operator: 'anyOf',
+              type: 'SearchMultiSelectCustomField',
+              value: [
+                '_lead',
+                '_customer'
+              ]
+            },
+            {
+              field: 'customFieldList',
+              value: [
+                {
+                  field: 'custentity_customerandcontacttypelist',
+                  operator: 'anyOf',
+                  # type is needed for multiselect fields
+                  type: 'SearchMultiSelectCustomField',
+                  value: [
+                    NetSuite::Records::CustomRecordRef.new(:internal_id => 4),
+                    NetSuite::Records::CustomRecordRef.new(:internal_id => 11),
+                  ]
+                },
+                {
+                  field: 'custentity_relatedthing',
+                  # is in the GUI is the equivilent of anyOf with a single element array
+                  operator: 'anyOf',
+                  type: 'SearchMultiSelectCustomField',
+                  value: [
+                    NetSuite::Records::Customer.new(:internal_id => 88825)
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        columns: [
+          'tranSales:basic' => {
+            'platformCommon:internalId/' => {},
+          }
+        ]
+      })
+
+      expect(search.results.size).to eq(2)
+      expect(search.current_page).to eq(1)
+      expect(search.results.first.internal_id).to eq('123')
+      expect(search.results.first.external_id).to eq('456')
+      expect(search.results.first.alt_name).to eq('A Awesome Name')
+      expect(search.results.first.custom_field_list.custitem_stringfield.value).to eq('sample string value')
+      expect(search.results.first.custom_field_list.custitem_apcategoryforsales.value.internal_id).to eq('4')
+      expect(search.results.last.email).to eq('alessawesome@gmail.com')
+    end
+
+    it "should handle an ID search with basic search only field result columns" do
+      response = File.read('spec/support/fixtures/search/saved_search_item.xml')
+      savon.expects(:search)
+        .with(message: {
+          "searchRecord"=>{
+            "@xsi:type"      =>"listAcct:ItemSearchAdvanced",
+            "@savedSearchId" =>42,
+            :content!        =>{"listAcct:criteria"=>{}},
+          }
+        }).returns(response)
+
+      search = NetSuite::Records::InventoryItem.search(saved: 42)
+
+      expect(search.results.first.location_quantity_available).to eq('3307.0')
+      expect(search.results.first.location_re_order_point).to eq('2565.0')
+      expect(search.results.first.location_quantity_on_order).to eq('40000.0')
+    end
+  end
+
+
+  context "basic search" do
+    it "should handle a basic search matching on RecordRef using internalId" do
+      response = File.read('spec/support/fixtures/search/basic_search_contact.xml')
+      savon.expects(:search)
+        .with(message: {
+          "searchRecord" => {
+            :content! => {
+              "listRel:basic" => {
+                "platformCommon:company" => {
+                  "@operator" => "anyOf",
+                  "@xsi:type" => "platformCore:SearchMultiSelectField",
+                  "platformCore:searchValue" => [
+                    {
+                      :content! => {},
+                      "@xsi:type" => "platformCore:RecordRef",
+                      "@type" => "account",
+                      "@internalId" => 7497,
+                    },
+                    {
+                      :content! => {},
+                      "@xsi:type" => "platformCore:RecordRef",
+                      "@type" => "account",
+                      "@internalId" => 7270,
+                    },
+                  ],
+                },
+              },
+            },
+            "@xsi:type" => "listRel:ContactSearch",
+          },
+        }).returns(response)
+
+      search = NetSuite::Records::Contact.search(
+        basic: [{
+          field: 'company',
+          operator: 'anyOf',
+          value: [
+            NetSuite::Records::RecordRef.new(internal_id: 7497),
+            NetSuite::Records::RecordRef.new(internal_id: 7270),
+          ],
+        }],
+      )
+
+      expect(search.results.size).to eq(1)
+    end
+
+    it "should handle a basic search matching on RecordRef using externalId" do
+      response = File.read('spec/support/fixtures/search/basic_search_contact.xml')
+      savon.expects(:search)
+        .with(message: {
+          "searchRecord" => {
+            :content! => {
+              "listRel:basic" => {
+                "platformCommon:company" => {
+                  "@operator" => "anyOf",
+                  "@xsi:type" => "platformCore:SearchMultiSelectField",
+                  "platformCore:searchValue" => [
+                    {
+                      :content! => {},
+                      "@xsi:type" => "platformCore:RecordRef",
+                      "@type" => "account",
+                      "@externalId" => "external_abc",
+                    },
+                    {
+                      :content! => {},
+                      "@xsi:type" => "platformCore:RecordRef",
+                      "@type" => "account",
+                      "@externalId" => "external_xyz",
+                    },
+                  ],
+                },
+              },
+            },
+            "@xsi:type" => "listRel:ContactSearch",
+          },
+        }).returns(response)
+
+      search = NetSuite::Records::Contact.search(
+        basic: [{
+          field: 'company',
+          operator: 'anyOf',
+          value: [
+            NetSuite::Records::RecordRef.new(external_id: "external_abc"),
+            NetSuite::Records::RecordRef.new(external_id: "external_xyz"),
+          ],
+        }],
+      )
+
+      expect(search.results.size).to eq(1)
+    end
+
+    it "should handle a basic search matching on RecordRef using mix of internalId and externalId" do
+      response = File.read('spec/support/fixtures/search/basic_search_contact.xml')
+      savon.expects(:search)
+        .with(message: {
+          "searchRecord" => {
+            :content! => {
+              "listRel:basic" => {
+                "platformCommon:company" => {
+                  "@operator" => "anyOf",
+                  "@xsi:type" => "platformCore:SearchMultiSelectField",
+                  "platformCore:searchValue" => [
+                    {
+                      :content! => {},
+                      "@xsi:type" => "platformCore:RecordRef",
+                      "@type" => "account",
+                      "@internalId" => 7497,
+                    },
+                    {
+                      :content! => {},
+                      "@xsi:type" => "platformCore:RecordRef",
+                      "@type" => "account",
+                      "@externalId" => "external_xyz",
+                    },
+                  ],
+                },
+              },
+            },
+            "@xsi:type" => "listRel:ContactSearch",
+          },
+        }).returns(response)
+
+      search = NetSuite::Records::Contact.search(
+        basic: [{
+          field: 'company',
+          operator: 'anyOf',
+          value: [
+            NetSuite::Records::RecordRef.new(internal_id: 7497),
+            NetSuite::Records::RecordRef.new(external_id: "external_xyz"),
+          ],
+        }],
+      )
+
+      expect(search.results.size).to eq(1)
+    end
+
+    it "should handle a basic search matching on RecordRef using both internalId and externalId" do
+      response = File.read('spec/support/fixtures/search/basic_search_contact.xml')
+      savon.expects(:search)
+        .with(message: {
+          "searchRecord" => {
+            :content! => {
+              "listRel:basic" => {
+                "platformCommon:company" => {
+                  "@operator" => "anyOf",
+                  "@xsi:type" => "platformCore:SearchMultiSelectField",
+                  "platformCore:searchValue" => [
+                    {
+                      :content! => {},
+                      "@xsi:type" => "platformCore:RecordRef",
+                      "@type" => "account",
+                      "@internalId" => 7497,
+                      "@externalId" => "external_abc",
+                    },
+                    {
+                      :content! => {},
+                      "@xsi:type" => "platformCore:RecordRef",
+                      "@type" => "account",
+                      "@externalId" => 7270,
+                    },
+                  ],
+                },
+              },
+            },
+            "@xsi:type" => "listRel:ContactSearch",
+          },
+        }).returns(response)
+
+      search = NetSuite::Records::Contact.search(
+        basic: [{
+          field: 'company',
+          operator: 'anyOf',
+          value: [
+            NetSuite::Records::RecordRef.new(internal_id: 7497, external_id: "external_abc"),
+            NetSuite::Records::RecordRef.new(external_id: 7270),
+          ],
+        }],
+      )
+
+      expect(search.results.size).to eq(1)
+    end
+
+  end
+end

data/spec/netsuite/actions/update_list_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe NetSuite::Actions::UpdateList do
+  before { savon.mock! }
+  after { savon.unmock! }
+
+  context 'Items' do
+    context 'one item' do
+      let(:item) do
+        [
+          NetSuite::Records::InventoryItem.new(internal_id: '624113', item_id: 'Target', upccode: 'Target')
+        ]
+      end
+
+      before do
+        savon.expects(:update_list).with(:message =>
+          {
+            'record' => [{
+              'listAcct:itemId' => 'Target',
+              '@xsi:type' => 'listAcct:InventoryItem',
+              '@internalId' => '624113'
+            }]
+          }).returns(File.read('spec/support/fixtures/update_list/update_list_one_item.xml'))
+      end
+
+      it 'makes a valid request to the NetSuite API' do
+        NetSuite::Actions::UpdateList.call(item)
+      end
+
+      it 'returns a valid Response object' do
+        response = NetSuite::Actions::UpdateList.call(item)
+        expect(response).to be_kind_of(NetSuite::Response)
+        expect(response).to be_success
+      end
+    end
+
+    context 'two items' do
+      let(:items) do
+        [
+          NetSuite::Records::InventoryItem.new(internal_id: '624172', item_id: 'Shutter Fly', upccode: 'Shutter Fly, Inc.'),
+          NetSuite::Records::InventoryItem.new(internal_id: '624113', item_id: 'Target', upccode: 'Target')
+        ]
+      end
+
+      before do
+        savon.expects(:update_list).with(:message =>
+          {
+            'record' => [{
+                'listAcct:itemId' => 'Shutter Fly',
+                '@xsi:type' => 'listAcct:InventoryItem',
+                '@internalId' => '624172'
+              },
+              {
+                'listAcct:itemId' => 'Target',
+                '@xsi:type' => 'listAcct:InventoryItem',
+                '@internalId' => '624113'
+              }
+            ]
+          }).returns(File.read('spec/support/fixtures/update_list/update_list_items.xml'))
+      end
+
+      it 'makes a valid request to the NetSuite API' do
+        NetSuite::Actions::UpdateList.call(items)
+      end
+
+      it 'returns a valid Response object' do
+        response = NetSuite::Actions::UpdateList.call(items)
+        expect(response).to be_kind_of(NetSuite::Response)
+        expect(response).to be_success
+      end
+    end
+  end
+
+  context 'with errors' do
+    let(:items) do
+      [
+        NetSuite::Records::InventoryItem.new(internal_id: '624172-bad', item_id: 'Shutter Fly', upccode: 'Shutter Fly, Inc.'),
+        NetSuite::Records::InventoryItem.new(internal_id: '624113-bad', item_id: 'Target', upccode: 'Target')
+      ]
+    end
+
+    before do
+      savon.expects(:update_list).with(:message =>
+        {
+          'record' => [{
+            'listAcct:itemId' => 'Shutter Fly',
+            '@xsi:type' => 'listAcct:InventoryItem',
+            '@internalId' => '624172-bad'
+          },
+          {
+            'listAcct:itemId' => 'Target',
+            '@xsi:type' => 'listAcct:InventoryItem',
+            '@internalId' => '624113-bad'
+          }
+          ]
+        }).returns(File.read('spec/support/fixtures/update_list/update_list_with_errors.xml'))
+    end
+
+    it 'constructs error objects' do
+      response = NetSuite::Actions::UpdateList.call(items)
+      expect(response.errors.keys).to match_array(['624172', '624113'])
+      expect(response.errors['624172'].first.code).to eq('USER_ERROR')
+      expect(response.errors['624172'].first.message).to eq('Please enter value(s) for: ItemId')
+      expect(response.errors['624172'].first.type).to eq('ERROR')
+    end
+  end
+end

data/spec/netsuite/actions/update_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+describe NetSuite::Actions::Update do
+  before(:all) { savon.mock! }
+  after(:all) { savon.unmock! }
+
+  context 'Customer' do
+    let(:customer) { NetSuite::Records::Customer.new }
+    let(:attributes) { { :entity_id => 'Shutter Fly', :company_name => 'Shutter Fly, Inc.' } }
+    let(:message) do
+      {
+        'platformMsgs:record' => {
+          :content! => {
+            'listRel:entityId'    => 'Shutter Fly',
+            'listRel:companyName' => 'Shutter Fly, Inc.',
+          },
+          '@xsi:type' => 'listRel:Customer'
+        },
+      }
+    end
+
+    describe 'updating the external ID' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :internal_id => '1' }) }
+
+      # https://github.com/NetSweet/netsuite/pull/416
+      #   if the external ID is set, and the external ID field is ommitted on an update, the external ID field does not change
+      #   if the external_id field is set to nil, it should not be passed to netsuite
+      #   passing an empty string to the external ID field does not remove it
+
+      it 'does not pass the external ID to an update call if not modified or included in update options' do
+        expect(NetSuite::Actions::Update).to receive(:call).
+            with([customer.class, {}], {}).
+            and_return(response)
+
+        expect(customer.update).to be_truthy
+      end
+
+      it 'should update the external ID when the attribute on the record is set' do
+        expect(NetSuite::Actions::Update).to receive(:call).
+            with([customer.class, {external_id: 'foo'}], {}).
+            and_return(response)
+
+        customer.external_id = 'foo'
+        expect(customer.update).to be_truthy
+      end
+
+      it 'should update the external ID to nil when the attribute on the record is set' do
+        expect(NetSuite::Actions::Update).to receive(:call).
+            with([customer.class, {external_id: nil}], {}).
+            and_return(response)
+
+        expect(customer.update(external_id: nil)).to be_truthy
+      end
+
+      it 'should update the external ID to the options value not the attribute value' do
+        expect(NetSuite::Actions::Update).to receive(:call).
+            with([customer.class, {external_id: 'bar'}], {}).
+            and_return(response)
+
+        customer.external_id = 'foo'
+        expect(customer.update(external_id: 'bar')).to be_truthy
+      end
+    end
+
+    context 'when successful' do
+
+      before do
+        savon.expects(:update).with(:message => message).returns(File.read('spec/support/fixtures/update/update_customer.xml'))
+      end
+
+      it 'makes a valid request to the NetSuite API' do
+        NetSuite::Actions::Update.call([NetSuite::Records::Customer, attributes])
+      end
+
+      it 'returns a valid Response object' do
+        response = NetSuite::Actions::Update.call([NetSuite::Records::Customer, attributes])
+        expect(response).to be_kind_of(NetSuite::Response)
+        expect(response).to be_success
+      end
+
+    end
+
+    context 'when not successful' do
+
+      before do
+        savon.expects(:update).with(:message => message).returns(File.read('spec/support/fixtures/update/update_customer_error.xml'))
+      end
+
+      it 'provides an errors method on the object with details about the errors' do
+        customer.update(attributes)
+        error = customer.errors.first
+
+        expect(error).to be_kind_of(NetSuite::Error)
+        expect(error.type).to eq('ERROR')
+        expect(error.code).to eq('INSUFFICIENT_PERMISSION')
+        expect(error.message).to eq('You do not have permissions to set a value for element addrtext due to one of the following reasons: 1) The field is read-only; 2) An associated feature is disabled; 3) The field is available either when a record is created or updated, but not in both cases.')
+      end
+
+      it 'provides an errors method on the response' do
+        response = NetSuite::Actions::Update.call([NetSuite::Records::Customer, attributes])
+        expect(response.errors.first).to be_kind_of(NetSuite::Error)
+      end
+
+    end
+
+    context 'when not successful with multiple errors' do
+
+      before do
+        savon.expects(:update).with(:message => message).returns(File.read('spec/support/fixtures/update/update_customer_multiple_errors.xml'))
+      end
+
+      it 'provides an errors method on the object with details about the errors' do
+        customer.update(attributes)
+        expect(customer.errors.length).to eq(2)
+
+        first_error = customer.errors.first
+        expect(first_error).to be_kind_of(NetSuite::Error)
+        expect(first_error.type).to eq('ERROR')
+        expect(first_error.code).to eq('First error code')
+        expect(first_error.message).to eq('First error message')
+
+        second_error = customer.errors.last
+        expect(second_error).to be_kind_of(NetSuite::Error)
+        expect(second_error.type).to eq('WARNING')
+        expect(second_error.code).to eq('Second error code')
+        expect(second_error.message).to eq('Second error message')
+
+      end
+    end
+
+  end
+
+end