avatax 23.4.1 → 23.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a7b6f6511b3ab49959a399340046d61a121066f136b93f77645b46cb109173f
-  data.tar.gz: 88b98f1671e8ab451b9cc3f181db617e3e0158189a4efb7961e99ae59c6233b3
+  metadata.gz: 495850eb2c0d245e185756aae4d2753b1cb2a07e18a88fc5ea9790f5323fdb9c
+  data.tar.gz: ea3832cdc0f463452416d74ecd061ff3cb81a5bafea0e8509ac421293f6a672f
 SHA512:
-  metadata.gz: aead5df9e3dd85139f492a957d3c1877d31ce4ce747c14fdbc5430b91d437ca572ebe901cb815abc932ffbf184193d6cc52f148b657eca946c1c0f1320a8eebe
-  data.tar.gz: 32a3ac9b4a97e675c716d0328e47fbee372c2abcf0916bd4e345bf5c6871859c4a77b8f77676144a1e43b7890046553b31224a0828436c3312cc43af59560897
+  metadata.gz: acd15ea0c82cfba6b5ac8e3c202c8df7565f0e3c0fc19920ef5835ebe46e5280a58d27b98ee48fcb8c0e0cda89f99783beeae01996dc46cfc790bb27b3bb5897
+  data.tar.gz: ee8671a5783506adaaab420c139d685db9eaf299f8128dd4da902b51355fb7744c2752105b344ab452cbd246232b1e7fa12567bc9c901867cb06a9403eabefac

data/lib/avatax/client/definitions.rb

@@ -641,7 +641,7 @@ module AvaTax
       # Returns the full list of Avalara-supported tax notice statuses.
       # This API is intended to be useful to identify all the different tax notice statuses.
       # Swagger Name: AvaTaxClient	  
-      # @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:* isOpen, sortOrder
+      # @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:* isOpen, sortOrder, activeFlag
       # @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`.
@@ -753,6 +753,7 @@ module AvaTax
       # @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`.
+      # @param includeExpiredPostalCodes [Boolean] If set to true, returns expired postal codes. Defaults to false
       # @return [FetchResult]
       def list_postal_codes(options={})        path = "/api/v2/definitions/postalcodes"
         get(path, options, AvaTax::VERSION)      end
@@ -1015,7 +1016,7 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # Swagger Name: AvaTaxClient	  
       # @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/).
       # @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.

data/lib/avatax/client/items.rb

@@ -483,7 +483,7 @@ module AvaTax
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The company id.
       # @param itemId [Integer] The item id.
-      # @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:* productCode, systemCode
+      # @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:* productCode, systemCode, IsPremium
       # @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/registrar.rb

@@ -46,26 +46,6 @@ module AvaTax
       def create_notifications(model)        path = "/api/v2/notifications"
         post(path, model, {}, AvaTax::VERSION)      end
 
-      # Create Avalara-supported subscription (ServiceTypes)
-      #
-      # For Registrar Use Only
-      # This API is for use by Avalara Registrar administrative users only.
-      #
-      # Create one service/subscription object.
-      #
-      # Returns the newly created Avalara-supported subscription (service) type.
-      # This API is intended to be useful for adding new Avalara-supported subscription type (service type).
-      # You may always contact Avalara's sales department for information on available products or services.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # Swagger Name: AvaTaxClient	  
-      # @param model [Object] The subscription type object you wish to create.
-      # @return [Object]
-      def create_service_types(model)        path = "/api/v2/servicetypes"
-        post(path, model, {}, AvaTax::VERSION)      end
-
       # Create a new subscription
       #
       # This API is for use by Avalara Registrar administrative users only.
@@ -124,23 +104,6 @@ module AvaTax
       def delete_notification(id)        path = "/api/v2/notifications/#{id}"
         delete(path, {}, AvaTax::VERSION)      end
 
-      # Delete a single Subscription (ServiceTypes) object
-      #
-      # For Registrar Use Only
-      # This API is for use by Avalara Registrar administrative users only.
-      #
-      # Marks the Subscription (ServiceTypes) object identified by this URL as deleted.
-      # This API is useful for deleting an existing Avalara-supported subscription type (service type).
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # Swagger Name: AvaTaxClient	  
-      # @param id [Integer] The unique ID number of the Subscription object you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_service_type(id)        path = "/api/v2/servicetypes/#{id}"
-        delete(path, {}, AvaTax::VERSION)      end
-
       # Delete a single subscription
       #
       # # For Registrar Use Only
@@ -242,25 +205,6 @@ module AvaTax
       def update_notification(id, model)        path = "/api/v2/notifications/#{id}"
         put(path, model, {}, AvaTax::VERSION)      end
 
-      # Update existing Avalara-supported subscription (ServiceTypes)
-      #
-      # For Registrar Use Only
-      # This API is for use by Avalara Registrar administrative users only.
-      #
-      # Returns the updated Avalara-supported service types.
-      # This API is intended to be useful for updating an existing subscription(service) type detail.
-      # You may always contact Avalara's sales department for information on available products or services.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # Swagger Name: AvaTaxClient	  
-      # @param id [Integer] The unique ID number of the existing subscription type object to replace.
-      # @param model [Object] The subscription type object to update.
-      # @return [Object]
-      def update_service_type(id, model)        path = "/api/v2/servicetypes/#{id}"
-        put(path, model, {}, AvaTax::VERSION)      end
-
       # Update a single subscription
       #
       # # For Registrar Use Only

data/lib/avatax/client/taxcodes.rb

@@ -45,7 +45,7 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this tax code
       # @param id [Integer] The primary key of this tax code
@@ -66,7 +66,7 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns these tax codes
       # @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/).
@@ -91,7 +91,7 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # Swagger Name: AvaTaxClient	  
       # @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/).
       # @param include [String] A comma separated list of additional data to retrieve.

data/lib/avatax/client/taxcontent.rb

@@ -141,8 +141,10 @@ module AvaTax
       # This API assumes that you are selling general tangible personal property at a retail point-of-sale
       # location in the United States only.
       #
-      # For more powerful tax calculation, please consider upgrading to the `CreateTransaction` API,
-      # which supports features including, but not limited to:
+      # Please be advised that this endpoint is designed for approximate tax rate estimation only and
+      # may not yield precise results. For a more powerful and accurate tax estimation, upgrade to the
+      # `CreateTransaction` API, which offers a variety of advanced features including, but not limited
+      # to:
       #
       # * Nexus declarations
       # * Taxability based on product/service type
@@ -177,8 +179,10 @@ module AvaTax
       # This API assumes that you are selling general tangible personal property at a retail point-of-sale
       # location in the United States only.
       #
-      # For more powerful tax calculation, please consider upgrading to the `CreateTransaction` API,
-      # which supports features including, but not limited to:
+      # Please be advised that this endpoint is designed for approximate tax rate estimation only and
+      # may not yield precise results. For a more powerful and accurate tax estimation, upgrade to the
+      # `CreateTransaction` API, which offers a variety of advanced features including, but not limited
+      # to:
       #
       # * Nexus declarations
       # * Taxability based on product/service type

data/lib/avatax/client/transactions.rb

@@ -283,6 +283,8 @@ module AvaTax
       #
       # To generate a refund for a transaction, use the `RefundTransaction` API.
       #
+      # An address is required for calculation. If no address is provided at the line level, the document level address will be used.
+      #
       # If you don't specify the field `type` in your request, you will get an estimate of type `SalesOrder`, which will not be recorded in the database.
       #
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -332,6 +334,8 @@ module AvaTax
       #
       # To generate a refund for a transaction, use the `RefundTransaction` API.
       #
+      # An address is required for calculation. If no address is provided at the line level, the document level address will be used.
+      #
       # The field `type` identifies the kind of transaction - for example, a sale, purchase, or refund. If you do not specify
       # a `type` value, you will receive an estimate of type `SalesOrder`, which will not be recorded.
       #

data/lib/avatax/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 23.4.1
+  version: 23.6.1
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2023-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake