Merge pull request #152 from avadev/23.5.0

svc-developer · web-flow · commit b7061acf074c · 2023-05-18T14:12:47.000-07:00
Update for 23.5.0
diff --git a/lib/avatax/client/definitions.rb b/lib/avatax/client/definitions.rb
@@ -641,7 +641,7 @@ def list_notice_root_causes(options={})        path = "/api/v2/definitions/notic
       # 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 @@ def list_permissions(options={})        path = "/api/v2/definitions/permissions"
       # @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 @@ def list_tax_authority_types(options={})        path = "/api/v2/definitions/taxa
       #
       # ### 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.
diff --git a/lib/avatax/client/taxcodes.rb b/lib/avatax/client/taxcodes.rb
@@ -45,7 +45,7 @@ def delete_tax_code(companyId, id)        path = "/api/v2/companies/#{companyId}
       #
       # ### 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 @@ def get_tax_code(companyId, id)        path = "/api/v2/companies/#{companyId}/ta
       #
       # ### 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 @@ def list_tax_codes_by_company(companyId, options={})        path = "/api/v2/comp
       #
       # ### 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.
diff --git a/lib/avatax/client/taxcontent.rb b/lib/avatax/client/taxcontent.rb
@@ -141,8 +141,10 @@ def download_tax_rates_by_zip_code(date, options={})        path = "/api/v2/taxr
       # 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 @@ def tax_rates_by_address(options={})        path = "/api/v2/taxrates/byaddress"
       # 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
diff --git a/lib/avatax/client/transactions.rb b/lib/avatax/client/transactions.rb
@@ -283,6 +283,8 @@ def commit_transaction(companyCode, transactionCode, model, options={})        p
       #
       # 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 @@ def create_or_adjust_transaction(model, options={})        path = "/api/v2/trans
       #
       # 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.
       #
diff --git a/lib/avatax/version.rb b/lib/avatax/version.rb
@@ -1,3 +1,3 @@
 ﻿module AvaTax
-  VERSION = '23.4.1'.freeze unless defined?(::AvaTax::VERSION)
+  VERSION = '23.5.0'.freeze unless defined?(::AvaTax::VERSION)
 end

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ def delete_tax_code(companyId, id) path = "/api/v2/companies/#{companyId}`
`45`	`45`	`#`
`46`	`46`	`# ### Security Policies`
`47`	`47`	`#`
`48`		`- # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.`
	`48`	`+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.`
`49`	`49`	`# Swagger Name: AvaTaxClient`
`50`	`50`	`# @param companyId [Integer] The ID of the company that owns this tax code`
`51`	`51`	`# @param id [Integer] The primary key of this tax code`
`@@ -66,7 +66,7 @@ def get_tax_code(companyId, id) path = "/api/v2/companies/#{companyId}/ta`
`66`	`66`	`#`
`67`	`67`	`# ### Security Policies`
`68`	`68`	`#`
`69`		`- # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.`
	`69`	`+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.`
`70`	`70`	`# Swagger Name: AvaTaxClient`
`71`	`71`	`# @param companyId [Integer] The ID of the company that owns these tax codes`
`72`	`72`	`# @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 @@ def list_tax_codes_by_company(companyId, options={}) path = "/api/v2/comp`
`91`	`91`	`#`
`92`	`92`	`# ### Security Policies`
`93`	`93`	`#`
`94`		`- # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.`
	`94`	`+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.`
`95`	`95`	`# Swagger Name: AvaTaxClient`
`96`	`96`	`# @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/).`
`97`	`97`	`# @param include [String] A comma separated list of additional data to retrieve.`
Original file line number	Diff line number	Diff line change
`@@ -283,6 +283,8 @@ def commit_transaction(companyCode, transactionCode, model, options={}) p`
`283`	`283`	`#`
`284`	`284`	# To generate a refund for a transaction, use the `RefundTransaction` API.
`285`	`285`	`#`
	`286`	`+ # An address is required for calculation. If no address is provided at the line level, the document level address will be used.`
	`287`	`+ #`
`286`	`288`	# 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.
`287`	`289`	`#`
`288`	`290`	`# A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like`
`@@ -332,6 +334,8 @@ def create_or_adjust_transaction(model, options={}) path = "/api/v2/trans`
`332`	`334`	`#`
`333`	`335`	# To generate a refund for a transaction, use the `RefundTransaction` API.
`334`	`336`	`#`
	`337`	`+ # An address is required for calculation. If no address is provided at the line level, the document level address will be used.`
	`338`	`+ #`
`335`	`339`	# The field `type` identifies the kind of transaction - for example, a sale, purchase, or refund. If you do not specify
`336`	`340`	# a `type` value, you will receive an estimate of type `SalesOrder`, which will not be recorded.
`337`	`341`	`#`