avatax 25.1.0 → 25.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa1155a6296f49af8222f9bc8086c233f43b226f7c1a37ec9e9f24f7885eacd9
-  data.tar.gz: 85c01a9cee7c89aa0426c4975b6fc71442d2ad4e5a938ad4439425e91a1dc42c
+  metadata.gz: 63be416a65fc180fbe510d51a313d090b9f483cde1d2498de8a46eced6720957
+  data.tar.gz: 529bf18e9f8e75c83274073b6a726f654414492a03638d68956dbb72e8aa619f
 SHA512:
-  metadata.gz: f8618a1521529122a70b671637467ca05f6b81129bfc1b587a3a8883131125859c81f3dc4f894f2ce450aa02b272492909270627bde8c47265b88753843863e7
-  data.tar.gz: 463d93fce3e936b6a6ac3ad6ce5453a34f1dd95162e46d3bfefdcc508857d87c720bdfa04240e7b36ff3c08878ef4c81bd236c7a0a3961f14d17fd7fc202ce7e
+  metadata.gz: e39a0d38a5f5586dc62d19549ab6e234a389b71e07e1f45e0af98e55acd403d21fd9b616f9953757b0e698b48ee013297f94157c7b9fc1b23b7a4a500f51f9d2
+  data.tar.gz: 73f618e48d35f9ea26e5dd7946d6e2b289f5af50171606daebc79dff77f6655f91d556fb34091e627146d34d2a1cdda4a93979805d3699634492cf3fd2334378

data/lib/avatax/api.rb

@@ -1,5 +1,6 @@
 require File.expand_path('../connection', __FILE__)
 require File.expand_path('../request', __FILE__)
+require 'active_support'
 require 'active_support/notifications'
 require 'logger'
 

data/lib/avatax/client/certificates.rb

@@ -301,7 +301,7 @@ module AvaTax
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID number of the company to search
       # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:      * customers - Retrieves the list of customers linked to the certificate.   * po_numbers - Retrieves all PO numbers tied to the certificate.   * attributes - Retrieves all attributes applied to the certificate.   * histories - Retrieves the certificate update history   * jobs - Retrieves the jobs for this certificate   * logs - Retrieves the certificate log   * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid   * custom_fields - Retrieves custom fields set for this certificate
-      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages
+      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages
       # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

data/lib/avatax/client/customers.rb

@@ -183,6 +183,26 @@ module AvaTax
       def link_ship_to_customers_to_bill_customer(companyId, code, model)        path = "/api/v2/companies/#{companyId}/customers/billto/#{code}/shipto/link"
         post(path, model, {}, AvaTax::VERSION)      end
 
+      # Retrieves a list of active certificates for a specified customer within a company.
+      #
+      # This API is intended to identify whether a customer has any active certificates.
+      #
+      # 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_active_certificates_for_customer(companyId, customerCode)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/active"
+        get(path, {}, AvaTax::VERSION)      end
+
       # Retrieve a customer's attributes
       #
       # Retrieve the attributes linked to the customer identified by this URL.
@@ -235,7 +255,7 @@ module AvaTax
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:      * customers - Retrieves the list of customers linked to the certificate.   * po_numbers - Retrieves all PO numbers tied to the certificate.   * attributes - Retrieves all attributes applied to the certificate.   * histories - Retrieves the certificate update history   * jobs - Retrieves the jobs for this certificate   * logs - Retrieves the certificate log   * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid   * custom_fields - Retrieves custom fields set for this certificate
-      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages
+      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages
       # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -243,6 +263,27 @@ 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 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,
+      # revoked, or otherwise non-compliant certificates.
+      #
+      # 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_in_active_certificates_for_customer(companyId, customerCode)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/inactive"
+        get(path, {}, AvaTax::VERSION)      end
+
       # List valid certificates for a location
       #
       # List valid certificates linked to a customer in a particular country and region.

data/lib/avatax/client/items.rb

@@ -305,6 +305,21 @@ module AvaTax
       def dismiss_h_s_code_classification_status(companyId, itemId, options={})        path = "/api/v2/companies/#{companyId}/items/#{itemId}/hscode-classifications-status/$dismiss"
         put(path, options, AvaTax::VERSION)      end
 
+      # Retrieve the HS code classification SLA details for a company.
+      #
+      # This endpoint returns the SLA details for HS code classification for the
+      # specified company. The response includes information about processing times,
+      # service commitments, and other relevant SLA terms.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The ID of the company for which to retrieve the SLA details.
+      # @return [Object]
+      def get_h_s_code_classification_s_l_a(companyId)        path = "/api/v2/companies/#{companyId}/items/hscode-classification/$get-sla"
+        get(path, {}, AvaTax::VERSION)      end
+
       # Retrieve a single item
       #
       # Get the `Item` object identified by this URL.

data/lib/avatax/client/reports.rb

@@ -55,7 +55,7 @@ module AvaTax
       # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
       # for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
       #
-      # * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
+      # * Begin a report by calling the report's Initiate API.
       # * In the result of the Initiate API, you receive back a report's `id` value.
       # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
       # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.

data/lib/avatax/client/transactions.rb

@@ -576,7 +576,7 @@ module AvaTax
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param dataSourceId [Integer] Optionally filter transactions to those from a specific data source.
       # @param include [String] Specifies objects to include in this fetch call
-      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms, apStatusCode, apStatus
+      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms, apStatusCode, apStatus, vendorName, varianceAmount
       # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

data/lib/avatax/version.rb

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

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require File.expand_path('../../lib/avatax', __FILE__)
 require 'rspec'
-require 'active_support'
 require 'yaml'
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 25.1.0
+  version: 25.3.0
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-28 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake