avatax 20.12.1 → 21.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d81263d9280d34bc49e5e2b7a4ef48c3fc2992855e0a3f84fe2a135d8118dff8
-  data.tar.gz: 6d504bc98c8e00570133858e195e5e133f3607050e9aefc2deabe725f5a90755
+  metadata.gz: a779b97acfcbecb8782c8f98309982313d1409cbb44f28d3ef65f396116e2c15
+  data.tar.gz: c491a1f18172047a20a1d4bfcdadafb05e077827402a4451d45aa9ef5cc63338
 SHA512:
-  metadata.gz: 9876aa4f7baf8b338485a22d00a4d0f44fa4179a3d496a3657925e61decb4e233086dd5e147efdbda1da4e07060a389d9246eb6c5be1c1303442f4c5b5211c82
-  data.tar.gz: ddf483cfe935d3ff293b6c30e702a343d127bfe41d98f21af14fa330c950a9d65ed737bcb3363178be213efd6c6c0bcfad74a9cd9afd39442b42654b3440ea18
+  metadata.gz: 98b845ac4ef06403f88ecf26fd0ba2d29547e6df6a8be1f3af2c494b5b4f6bae10fc1ef8bf655244636123497011f528d653f6648824704313a4e7193d1bb01d
+  data.tar.gz: dad022262512d018cba8963e3abde005460b159f86b0a41e678a06aded9b3598565512bef7eb0b17fc4be4e472a0f5a21af4e8a10e8bd9e140d94720bb227c6a

data/lib/avatax/client/advancedrules.rb

@@ -22,16 +22,6 @@ module AvaTax
       def delete_lookup_file(accountId, id)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
         delete(path)      end
 
-      # Get audit records by account id and date range.
-      #
-      # 
-      # @param accountId [Integer] The ID of the account
-      # @param fromDate [String] Date
-      # @param toDate [String] Date
-      # @return [Object]
-      def get_audit_records(accountId, fromDate, toDate)        path = "/api/v2/advancedrules/audits/accounts/#{accountId}/from/#{fromDate}/to/#{toDate}"
-        get(path)      end
-
       # Get the lookup files for a company
       #
       # 

data/lib/avatax/client/definitions.rb

@@ -348,7 +348,7 @@ module AvaTax
       # Returns the full list of all Avalara-supported nexus for all countries and regions.
       #
       # This API is intended to be useful if your user interface needs to display a selectable list of nexus.
-      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
+      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
       # @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`.
@@ -370,7 +370,7 @@ module AvaTax
       # @param region [String] Name or ISO 3166 code identifying the region portion of the address.      This field supports many different region identifiers:   * Two and three character ISO 3166 region codes   * Fully spelled out names of the region in ISO supported languages   * Common alternative spellings for many regions      For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
       # @param postalCode [String] The postal code or zip code portion of this address.
       # @param country [String] Name or ISO 3166 code identifying the country portion of this address.      This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries      For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
-      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
+      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
       # @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`.
@@ -384,7 +384,7 @@ module AvaTax
       #
       # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
       # @param country [String] The country in which you want to fetch the system nexus
-      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
+      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
       # @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`.
@@ -399,7 +399,7 @@ module AvaTax
       # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
       # @param country [String] The two-character ISO-3166 code for the country.
       # @param region [String] The two or three character region code for the region.
-      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
+      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
       # @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/free.rb

@@ -23,79 +23,6 @@ module AvaTax
       # @return [Object]
       def request_free_trial(model)        path = "/api/v2/accounts/freetrials/request"
         post(path, model)      end
-
-      # FREE API - Sales tax rates for a specified address
-      #
-      # # Free-To-Use
-      #
-      # The TaxRates API is a free-to-use, no cost option for estimating sales tax rates.
-      # Any customer can request a free AvaTax account and make use of the TaxRates API.
-      #
-      # Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP
-      # response code 429 - `Too Many Requests`.
-      #
-      # 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:
-      #
-      # * Nexus declarations
-      # * Taxability based on product/service type
-      # * Sourcing rules affecting origin/destination states
-      # * Customers who are exempt from certain taxes
-      # * States that have dollar value thresholds for tax amounts
-      # * Refunds for products purchased on a different date
-      # * Detailed jurisdiction names and state assigned codes
-      # * And more!
-      #
-      # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
-      # for information on how to upgrade to the full AvaTax CreateTransaction API.
-      # @param line1 [String] The street address of the location.
-      # @param line2 [String] The street address of the location.
-      # @param line3 [String] The street address of the location.
-      # @param city [String] The city name of the location.
-      # @param region [String] Name or ISO 3166 code identifying the region within the country.     This field supports many different region identifiers:   * Two and three character ISO 3166 region codes   * Fully spelled out names of the region in ISO supported languages   * Common alternative spellings for many regions     For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
-      # @param postalCode [String] The postal code of the location.
-      # @param country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
-      # @return [Object]
-      def tax_rates_by_address(options={})        path = "/api/v2/taxrates/byaddress"
-        get(path, options)      end
-
-      # FREE API - Sales tax rates for a specified country and postal code. This API is only available for US postal codes.
-      #
-      # # Free-To-Use
-      #
-      # This API is only available for a US postal codes.
-      #
-      # The TaxRates API is a free-to-use, no cost option for estimating sales tax rates.
-      # Any customer can request a free AvaTax account and make use of the TaxRates API.
-      #
-      # Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP
-      # response code 429 - `Too Many Requests`.
-      #
-      # 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:
-      #
-      # * Nexus declarations
-      # * Taxability based on product/service type
-      # * Sourcing rules affecting origin/destination states
-      # * Customers who are exempt from certain taxes
-      # * States that have dollar value thresholds for tax amounts
-      # * Refunds for products purchased on a different date
-      # * Detailed jurisdiction names and state assigned codes
-      # * And more!
-      #
-      # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
-      # for information on how to upgrade to the full AvaTax CreateTransaction API.
-      # @param country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
-      # @param postalCode [String] The postal code of the location.
-      # @return [Object]
-      def tax_rates_by_postal_code(options={})        path = "/api/v2/taxrates/bypostalcode"
-        get(path, options)      end
     end
   end
 end

data/lib/avatax/client/nexus.rb

@@ -225,7 +225,7 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that owns these nexus objects
-      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
+      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
       # @param include [String] A comma separated list of additional data to retrieve.
       # @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.
@@ -276,7 +276,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
+      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
       # @param include [String] A comma separated list of additional data to retrieve.
       # @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.

data/lib/avatax/client/reports.rb

@@ -60,6 +60,15 @@ module AvaTax
       #
       # The `ExportDocumentLine` report produces information about invoice lines recorded within your account.
       #
+      # To split large reports into multiple smaller partitions, use the numberOfPartitions and partition properties on ExportDocumentLineModel.
+      #
+      # Example - split a report into three partitions
+      #
+      # * Follow the steps above with numberOfPartitions = 3 and partition = 0
+      # * Follow the steps above with numberOfPartitions = 3 and partition = 1
+      # * Follow the steps above with numberOfPartitions = 3 and partition = 2
+      # * Once all three reports are downloaded merge the files on the client side.
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.

data/lib/avatax/client/taxcontent.rb

@@ -129,6 +129,69 @@ module AvaTax
       # @return [Object]
       def download_tax_rates_by_zip_code(date, options={})        path = "/api/v2/taxratesbyzipcode/download/#{date}"
         get(path, options)      end
+
+      # Sales tax rates for a specified address
+      #
+      # Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP
+      # response code 429 - `Too Many Requests`.
+      #
+      # 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:
+      #
+      # * Nexus declarations
+      # * Taxability based on product/service type
+      # * Sourcing rules affecting origin/destination states
+      # * Customers who are exempt from certain taxes
+      # * States that have dollar value thresholds for tax amounts
+      # * Refunds for products purchased on a different date
+      # * Detailed jurisdiction names and state assigned codes
+      # * And more!
+      #
+      # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
+      # for information on how to upgrade to the full AvaTax CreateTransaction API.
+      # @param line1 [String] The street address of the location.
+      # @param line2 [String] The street address of the location.
+      # @param line3 [String] The street address of the location.
+      # @param city [String] The city name of the location.
+      # @param region [String] Name or ISO 3166 code identifying the region within the country.     This field supports many different region identifiers:   * Two and three character ISO 3166 region codes   * Fully spelled out names of the region in ISO supported languages   * Common alternative spellings for many regions     For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
+      # @param postalCode [String] The postal code of the location.
+      # @param country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
+      # @return [Object]
+      def tax_rates_by_address(options={})        path = "/api/v2/taxrates/byaddress"
+        get(path, options)      end
+
+      # Sales tax rates for a specified country and postal code. This API is only available for US postal codes.
+      #
+      # This API is only available for a US postal codes.
+      #
+      # Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP
+      # response code 429 - `Too Many Requests`.
+      #
+      # 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:
+      #
+      # * Nexus declarations
+      # * Taxability based on product/service type
+      # * Sourcing rules affecting origin/destination states
+      # * Customers who are exempt from certain taxes
+      # * States that have dollar value thresholds for tax amounts
+      # * Refunds for products purchased on a different date
+      # * Detailed jurisdiction names and state assigned codes
+      # * And more!
+      #
+      # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
+      # for information on how to upgrade to the full AvaTax CreateTransaction API.
+      # @param country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
+      # @param postalCode [String] The postal code of the location.
+      # @return [Object]
+      def tax_rates_by_postal_code(options={})        path = "/api/v2/taxrates/bypostalcode"
+        get(path, options)      end
     end
   end
 end

data/lib/avatax/configuration.rb

@@ -29,7 +29,7 @@ module AvaTax
     DEFAULT_USER_AGENT = "AvaTax Ruby Gem #{AvaTax::VERSION}".freeze
     DEFAULT_USERNAME = nil
     DEFAULT_PASSWORD = nil
-    DEFAULT_CONNECTION_OPTIONS = {}
+    DEFAULT_CONNECTION_OPTIONS = {request: {timeout: 1200}} # timeout in seconds
     DEFAULT_LOGGER = false
     DEFAULT_CUSTOM_LOGGER = nil
     DEFAULT_CUSTOM_LOGGER_OPTIONS = {}

data/lib/avatax/request.rb

@@ -22,8 +22,6 @@ module AvaTax
 
     def request(method, path, model, options={})
       response = connection.send(method) do |request|
-        # timeout in seconds
-        request.options['timeout'] = 1200
         case method
         when :get, :delete
           request.url("#{URI.encode(path)}?#{URI.encode_www_form(options)}")

data/lib/avatax/version.rb

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

data/spec/avatax/request_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe AvaTax::Request do
+
+  describe ".request" do
+    it "should default to a 1200 second timeout" do
+      @client.faraday_response = true
+      response = @client.request(:get, 'path', 'model')
+      expect(response.env.request['timeout']).to eq(1200)
+    end
+
+    it "should allow setting a custom timeout" do
+      @client.faraday_response = true
+      @client.connection_options = {
+        request: {
+          open_timeout: 5,
+          timeout: 10
+        }
+      }
+      response = @client.request(:get, 'path', 'model')
+      expect(response.env.request['open_timeout']).to eq(5)
+      expect(response.env.request['timeout']).to eq(10)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 20.12.1
+  version: 21.1.2
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -170,6 +170,7 @@ files:
 - lib/avatax/version.rb
 - spec/avatax/client/accounts_spec.rb
 - spec/avatax/client/transactions_spec.rb
+- spec/avatax/request_spec.rb
 - spec/avatax_spec.rb
 - spec/credentials.yaml.example
 - spec/fixtures/accounts.json