avatax 25.3.0 → 25.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63be416a65fc180fbe510d51a313d090b9f483cde1d2498de8a46eced6720957
-  data.tar.gz: 529bf18e9f8e75c83274073b6a726f654414492a03638d68956dbb72e8aa619f
+  metadata.gz: 9508ea51c880c6d5dee5cd33bf392bcfe1ceb94d15f5d2a361744669999619c0
+  data.tar.gz: c69c43ea15a4a19bbfa16a41398b0a79a9f589561570fc1f28d3b9256ba98c8c
 SHA512:
-  metadata.gz: e39a0d38a5f5586dc62d19549ab6e234a389b71e07e1f45e0af98e55acd403d21fd9b616f9953757b0e698b48ee013297f94157c7b9fc1b23b7a4a500f51f9d2
-  data.tar.gz: 73f618e48d35f9ea26e5dd7946d6e2b289f5af50171606daebc79dff77f6655f91d556fb34091e627146d34d2a1cdda4a93979805d3699634492cf3fd2334378
+  metadata.gz: e26875ce9c8c8764c861907f2f28e538a965820b3df4399c035c3ab0e86a48d453d4ed2508633d077a2b8ac800d80833eba023bbe76b03a5e060245f32fb0315
+  data.tar.gz: 0a209ba299d7d5068a155e5ad9bd3dbb8413052ce1efbf5410507b14ea909624ffdd235af488000e78de3ba41a0b9796b00678ba2f9391636b4c9e2e91ffd5a0

data/.github/workflows/gem-push.yml

@@ -6,26 +6,43 @@ on:
 
 jobs:
   build:
-    name: Build + Publish
+    name: Build + Test + Publish
     runs-on: ubuntu-latest
     permissions:
       contents: read
       packages: write
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: '2.6'
-    
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build avatax.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby 2.6
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "2.6"
+          bundler-cache: true # Caches gems between runs
+
+      - name: Write AvaTax credentials to credentials.yaml
+        run: |
+          cat <<EOF > spec/credentials.yaml
+          endpoint: https://sandbox-rest.avatax.com
+          username: "${{ secrets.SANDBOX_USERNAME }}"
+          password: "${{ secrets.SANDBOX_PASSWORD }}"
+          EOF
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run RSpec tests
+        run: bundle exec rspec
+
+      - name: Publish to RubyGems
+        if: success() # Only runs if tests pass
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build avatax.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitlab-ci.yml

@@ -0,0 +1,8 @@
+include:
+  - project: "prodsec/security-ci-cd"
+    ref: release-0.1.7
+    file: "templates/security-ci-cd.yml"
+
+sast:tests:
+  extends: .sast:tests
+  stage: testing:development

data/lib/avatax/client/batches.rb

@@ -28,6 +28,30 @@ module AvaTax
       def cancel_batch(companyId, id)        path = "/api/v2/companies/#{companyId}/batches/#{id}/cancel"
         post(path, {}, {}, AvaTax::VERSION)      end
 
+      # Create a new Advanced Rules batch
+      #
+      # Create a new Advanced Rules batch objects attached to this company.
+      #
+      # When an Advanced Rules batch is created, it is added to the AvaTax Batch v2 Queue and will be
+      # processed as quickly as possible in the order it was received. To check the
+      # status of a batch, fetch the batch and retrieve the results of the batch
+      # operation.
+      #
+      # The maximum content length of the request body is limited to 28.6 MB. If this limit
+      # is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if
+      # the API is called from a browser). In this situation, please split the request into
+      # smaller batches.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The ID of the company that owns this batch.
+      # @param model [Object] The Advanced Rules batch you wish to create.
+      # @return [Object]
+      def create_advanced_rules_batch(companyId, model)        path = "/api/v2/companies/#{companyId}/batches/advancedrules"
+        post(path, model, {}, AvaTax::VERSION)      end
+
       # Create a new batch
       #
       # Create one or more new batch objects attached to this company.

data/lib/avatax/client/certificates.rb

@@ -66,6 +66,27 @@ module AvaTax
       def delete_certificate(companyId, id)        path = "/api/v2/companies/#{companyId}/certificates/#{id}"
         delete(path, {}, AvaTax::VERSION)      end
 
+      # Delete Certificate Custom Fields
+      #
+      # Deletes custom fields for a specified certificate.
+      #
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique ID number of the company that recorded this certificate
+      # @param id [Integer] The unique ID number of this certificate
+      # @param model [DeleteCustomFields[]] Delete custom fields request model
+      # @return []
+      def delete_certificate_custom_fields(companyId, id, model)        path = "/api/v2/companies/#{companyId}/certificates/#{id}/custom-fields"
+        delete(path, model, {}, AvaTax::VERSION)      end
+
       # Download an image for this certificate
       #
       # Download an image or PDF file for this certificate.
@@ -269,6 +290,25 @@ module AvaTax
       def list_customers_for_certificate(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers"
         get(path, options, AvaTax::VERSION)      end
 
+      # Retrieve Certificate Custom Fields
+      #
+      # This API is used to retrieve custom fields for a certificate.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique ID number of the company that recorded this certificate
+      # @param id [Integer] The unique ID number of this certificate
+      # @return [Object]
+      def list_custom_fields_for_certificate(companyId, id)        path = "/api/v2/companies/#{companyId}/certificates/#{id}/custom-fields"
+        get(path, {}, AvaTax::VERSION)      end
+
       # List all certificates for a company
       #
       # List all certificates recorded by a company
@@ -417,6 +457,27 @@ module AvaTax
       def update_certificate(companyId, id, model)        path = "/api/v2/companies/#{companyId}/certificates/#{id}"
         put(path, model, {}, AvaTax::VERSION)      end
 
+      # Update Certificate Custom Fields
+      #
+      # Updates the values of custom fields for a certificate
+      #
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique ID number of the company that recorded this certificate
+      # @param id [Integer] The unique ID number of this certificate
+      # @param model [Object] The request model containing updated custom field values
+      # @return []
+      def update_certificate_custom_fields(companyId, id, model)        path = "/api/v2/companies/#{companyId}/certificates/#{id}/custom-fields"
+        put(path, model, {}, AvaTax::VERSION)      end
+
       # Upload an image or PDF attachment for this certificate
       #
       # Upload an image or PDF attachment for this certificate.

data/lib/avatax/client/customers.rb

@@ -58,6 +58,27 @@ module AvaTax
       def delete_customer(companyId, customerCode)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
         delete(path, {}, AvaTax::VERSION)      end
 
+      # Delete custom fields
+      #
+      # Deletes the value of the custom field.
+      #
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique ID number of the company that recorded this customer
+      # @param customerCode [String] The unique code representing this customer
+      # @param model [DeleteCustomFields[]] Delete custom fields request model
+      # @return []
+      def delete_custom_fields(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/custom-fields"
+        delete(path, model, {}, AvaTax::VERSION)      end
+
       # Retrieve a single customer
       #
       # Retrieve the customer identified by this URL.
@@ -263,6 +284,25 @@ module AvaTax
       def list_certificates_for_customer(companyId, customerCode, options={})        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates"
         get(path, options, AvaTax::VERSION)      end
 
+      # Retrieves a list of custom fields for a specified customer within a company.
+      #
+      # This API is used to retrieve custom field for a customer.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique ID number of the company that recorded this customer
+      # @param customerCode [String] The unique code representing this customer
+      # @return [Object]
+      def list_custom_fields_for_customer(companyId, customerCode)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/custom-fields"
+        get(path, {}, AvaTax::VERSION)      end
+
       # Retrieves a list of inactive certificates for a specified customer within a company.
       #
       # This API is used to retrieve inactive certificates for a customer. Inactive certificates may include expired,
@@ -441,6 +481,27 @@ module AvaTax
       # @return [Object]
       def update_customer(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
         put(path, model, {}, AvaTax::VERSION)      end
+
+      # Update custom fields
+      #
+      # Update the value of the custom field.
+      #
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique ID number of the company that recorded this customer
+      # @param customerCode [String] The unique code representing this customer
+      # @param model [Object] Update custom fields request model
+      # @return []
+      def update_custom_fields(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/custom-fields"
+        put(path, model, {}, AvaTax::VERSION)      end
     end
   end
 end

data/lib/avatax/client/taxcontent.rb

@@ -27,7 +27,7 @@ module AvaTax
       # This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content
       # file for a single location at a time, please use `BuildTaxContentFileForLocation`.
       #
-      # NOTE: This API does not work for Tennessee tax holiday scenarios.
+      # NOTE: This API does not work for sales tax holiday scenarios.
       #
       # ### Security Policies
       #
@@ -63,7 +63,7 @@ module AvaTax
       # This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content
       # file for a multiple locations in a single file, please use `BuildTaxContentFile`.
       #
-      # NOTE: This API does not work for Tennessee tax holiday scenarios.
+      # NOTE: This API does not work for sales tax holiday scenarios.
       #
       # ### Security Policies
       #

data/lib/avatax/request.rb

@@ -18,6 +18,10 @@ module AvaTax
       request(:put, path, model, options, apiversion, headers)
     end
 
+    def patch(path, model, options={}, apiversion="", headers=Hash.new)
+      request(:patch, path, model, options, apiversion, headers)
+    end
+
     def delete(path, options={}, apiversion="", headers=Hash.new)
       request(:delete, path, nil, options, apiversion, headers)
     end
@@ -29,7 +33,7 @@ module AvaTax
         case method
         when :get, :delete
           request.url("#{encode_path(path)}?#{URI.encode_www_form(options)}")
-        when :post, :put
+        when :post, :put, :patch
           request.url("#{encode_path(path)}?#{URI.encode_www_form(options)}")
           request.headers['Content-Type'] = 'application/json'
           request.body = model.to_json unless model.empty?

data/lib/avatax/version.rb

@@ -1,3 +1,3 @@
 module AvaTax
-  VERSION = '25.3.0'.freeze unless defined?(::AvaTax::VERSION)
+  VERSION = '25.3.3'.freeze unless defined?(::AvaTax::VERSION)
 end

data/spec/avatax/client/items_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe AvaTax::Client do
+  describe ".items" do
+    it "should create and update an item for the first company" do
+      # Get the first company
+      companies = @client.query_companies()
+      company = companies["value"][0]
+      company_id = company["id"]
+      puts "Using company ID: #{company_id}"
+
+      # Create a new item
+      item_code = "TEST_ITEM_#{Time.now.to_i}"
+      item_model = {
+        "itemCode" => item_code,
+        "description" => "Test Item Created via RSpec",
+        "taxCode" => "P0000000"
+      }
+
+      created_response = @client.create_items(company_id, [item_model])
+      created_item = created_response.first
+
+      # Assert item creation
+      expect(created_item).to be_a(Hash)
+      expect(created_item["itemCode"]).to eq(item_code)
+      expect(created_item["description"]).to eq("Test Item Created via RSpec")
+      expect(created_item["taxCode"]).to eq("P0000000")
+
+      puts "Created item: #{created_item}"
+
+      # Prepare JSON Patch operation
+      item_id = created_item["id"]
+      patch_operations = [
+        {
+          "op" => "replace",
+          "path" => "/description",
+          "value" => "Updated Description via RSpec"
+        }
+      ]
+
+      # Call patch_item
+      updated_item = @client.patch_item(company_id, item_id, patch_operations)
+
+      expect(updated_item).to be_a(Hash)
+      expect(updated_item["id"]).to eq(item_id)
+      expect(updated_item["description"]).to eq("Updated Description via RSpec")
+
+      puts "Updated item: #{updated_item}"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -16,12 +16,17 @@ AvaTax.configure do |config|
   end
 end
 
-client = AvaTax::Client.new({ :logger => true, :log_request_and_response_info => true })
+client = AvaTax::Client.new({ logger: true, log_request_and_response_info: true })
 companies = client.query_companies
 
+# Find the first active company manually
+active_company = companies["value"].find { |company| company["isActive"] == true }
+
+raise "No active company found" unless active_company
+
 RSpec.configure do |config|
   config.before {
     @client = client
-    @company_code = companies["value"][0]["companyCode"]
+    @company_code = active_company["companyCode"]
   }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 25.3.0
+  version: 25.3.3
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-06 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -103,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/gem-push.yml"
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".vs/AvaTax-REST-V2-Ruby-SDK/v15/.suo"
 - ".vs/VSWorkspaceState.json"
@@ -179,6 +180,7 @@ files:
 - lib/avatax/request.rb
 - lib/avatax/version.rb
 - spec/avatax/client/accounts_spec.rb
+- spec/avatax/client/items_spec.rb
 - spec/avatax/client/transactions_spec.rb
 - spec/avatax/request_spec.rb
 - spec/avatax_spec.rb