avatax 18.4.1 → 18.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c682c2d510ba0f739f3528ea2e37581b8c00e0150ca278f8fac37b612e88bc0
-  data.tar.gz: 45b64370a02b2f67278a300f057730b674e372da22ffbd2cf9605a13eb68f70e
+  metadata.gz: 2a76fdb83a5c471fa9773fd14b692eedc72dcfcc40d0b5a64b4a702bfc2888bc
+  data.tar.gz: 2756b24bd169058892928ffb36c949523558326f3f558558f4d1686ee22bd589
 SHA512:
-  metadata.gz: bcf764f94c7845a671f54e271098edac1630ddd1f1defcb3f6ef4e86fbdb5b305216cdadbaa107fa754d1b9bb5d450ad5893dfd8a1885393786c1bf45d3e562b
-  data.tar.gz: 33088610c8a59d0b8b77ead54972f4073c1f29724cb523ae17c2e557c5f8458c64185711113cbcad86bc3a6ba58f7aae6e44d433c4d458050e157cfa577e364b
+  metadata.gz: 182a5ae62e391f7d0501c6be42626a05815c26c5e3fe7e288ffdceeeca5083034ee9200077b58fbe73a51f677b4850f95dd18cd0759970104bbb421559d224fe
+  data.tar.gz: b12f298325080c3188ec59148f7ca2dea3376559f2b555a600482b21f1d20a004cbce4bda0e4ee6a75f4c1a7249f596938b21b4a7a971621d179463b9a5c6a42

data/lib/avatax/client/advancedrules.rb

@@ -76,6 +76,34 @@ module AvaTax
       end
 
 
+      # Disable an advanced rule so that it cannot be run.
+      #
+      # This API is available by invite only and implementation support is required.
+      # Please contact your Customer Account Manager if you are interested in using
+      # Advanced Rules in your AvaTax integration. ///
+      # @param accountId [Integer] 
+      # @param scriptType [String] The script transform type: Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
+      # @return [Object]
+      def disable_advanced_rule_script(accountId, scriptType)
+        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}/disable"
+        post(path)
+      end
+
+
+      # Enable an approved advanced rule so that it can be run.
+      #
+      # This API is available by invite only and implementation support is required.
+      # Please contact your Customer Account Manager if you are interested in using
+      # Advanced Rules in your AvaTax integration.
+      # @param accountId [Integer] 
+      # @param scriptType [String] The script transform type: Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
+      # @return [Object]
+      def enable_advanced_rule_script(accountId, scriptType)
+        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}/enable"
+        post(path)
+      end
+
+
       # Get an account's advanced rule script.
       #
       # This API is available by invite only and implementation support is required.

data/lib/avatax/client/batches.rb

@@ -30,7 +30,16 @@ module AvaTax
 
       # Delete a single batch
       #
-      # 
+      # Marks the batch identified by this URL as deleted.
+      #
+      # If you attempt to delete a batch that is being processed, you will receive an error message.
+      # Deleting a batch does not delete any transactions that were created by importing the batch.
+      #
+      # Because the batch system processes with a degree of concurrency, and
+      # because of batch sizes in the queue vary, AvaTax API is unable to accurately
+      # predict when a batch will complete. If high performance processing is
+      # required, please use the
+      # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
       # @param companyId [Integer] The ID of the company that owns this batch.
       # @param id [Integer] The ID of the batch to delete.
       # @return [ErrorDetail[]]

data/lib/avatax/client/companies.rb

@@ -271,9 +271,14 @@ module AvaTax
       # Update a single company
       #
       # Replace the existing company object at this URL with an updated object.
-      # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
+      #
+      # A `CompanyModel` represents a single corporation or individual that is registered to handle transactional taxes.
       # All data from the existing object will be replaced with data in the object you PUT.
-      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
+      #
+      # When calling `UpdateCompany`, you are permitted to update the company itself. Updates to the nested objects
+      # such as contacts, locations, or settings are not permitted. To update the nested objects
+      #
+      # To set a field's value to `null`, you may either set its value to `null` or omit that field from the object you PUT.
       # @param id [Integer] The ID of the company you wish to update.
       # @param model [Object] The company object you wish to update.
       # @return [Object]

data/lib/avatax/client/definitions.rb

@@ -648,10 +648,8 @@ module AvaTax
       #
       # Returns the full list of Avalara-supported permission types.
       # This API is intended to be useful to identify the capabilities of a particular user logon.
-      # @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.
       # @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`.
       # @return [FetchResult]
       def list_permissions(options={})
         path = "/api/v2/definitions/permissions"
@@ -862,10 +860,8 @@ module AvaTax
       # Returns the full list of recognized tax code types.
       # A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode.
       # This API is intended to be useful for broadly searching for tax codes by tax code type.
-      # @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.
       # @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`.
       # @return [Object]
       def list_tax_code_types(options={})
         path = "/api/v2/definitions/taxcodetypes"

data/lib/avatax/client/filingcalendars.rb

@@ -176,6 +176,7 @@ module AvaTax
       # A "filing request" represents a request to change an existing filing calendar. Filing requests
       # are reviewed and validated by Avalara Compliance before being implemented.
       # @param companyId [Integer] The ID of the company that owns these batches
+      # @param filingCalendarId [Integer] Specific filing calendar id for the request
       # @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.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
@@ -238,6 +239,7 @@ module AvaTax
       #
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      # @param filingCalendarId [Integer] Specific filing calendar id for the request
       # @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.
       # @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/free.rb

@@ -5,18 +5,16 @@ module AvaTax
 
       # FREE API - Request a free trial of AvaTax
       #
-      # Call this API to obtain a free AvaTax sandbox account.
+      # Call this API to obtain a free AvaTax account.
       #
-      # This API is free to use. No authentication credentials are required to call this API. You must read and accept Avalara's terms and conditions.
-      # The account will grant a full trial version of AvaTax (e.g. AvaTaxPro) for a limited period of time.
-      # After this introductory period, you may continue to use the free TaxRates API.
+      # This API is free to use. No authentication credentials are required to call this API. You must read and
+      # accept [Avalara's terms and conditions](https://www1.avalara.com/us/en/legal/terms.html) for the account to be
+      # created.
       #
-      # Limitations on free trial accounts:
+      # If all conditions are met, this API will grant a free trial version of AvaTax. For a list of functionality
+      # available in the free trial and its limitations, please see the [AvaTax Developer Website Free Trial page](https://developer.avalara.com/avatax/signup/).
       #
-      # * Only one free trial per company.
-      # * The free trial account does not expire.
-      # * Includes a limited time free trial of AvaTaxPro; after that date, the free TaxRates API will continue to work.
-      # * Each free trial account must have its own valid email address.
+      # After your free trial concludes, you will still be able to use the [Free AvaTax API Suite](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Free/).
       # @param model [Object] Required information to provision a free trial account.
       # @return [Object]
       def request_free_trial(model)

data/lib/avatax/client/notices.rb

@@ -3,6 +3,22 @@ module AvaTax
     module Notices 
 
 
+      # Delete a single notice.
+      #
+      # This API is available by invitation only.
+      # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
+      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
+      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
+      # @param companyId [Integer] The ID of the company that owns this notice.
+      # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
+      # @param commentDetailsId [Integer] The ID of the comment you wish to delete.
+      # @return [ErrorDetail[]]
+      def comment_details_delete(companyId, id, commentDetailsId)
+        path = "/api/v2/companies/#{companyId}/notices/#{id}/commentdetails/#{commentdetailsid}"
+        delete(path)
+      end
+
+
       # Create a new notice comment.
       #
       # This API is available by invitation only.
@@ -143,6 +159,23 @@ module AvaTax
       end
 
 
+      # Delete a single notice.
+      #
+      # This API is available by invitation only.
+      # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
+      # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
+      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
+      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
+      # @param companyId [Integer] The ID of the company that owns this notice.
+      # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
+      # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
+      # @return [ErrorDetail[]]
+      def financedetailsdelete(companyId, id, financeDetailsId)
+        path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails/#{financedetailsid}"
+        delete(path)
+      end
+
+
       # Retrieve a single notice.
       #
       # This API is available by invitation only.

data/lib/avatax/client/registrar.rb

@@ -27,7 +27,7 @@ module AvaTax
       # Create a single new account object.
       # When creating an account object you may attach subscriptions and users as part of the 'Create' call.
       # @param model [Object] The account you wish to create.
-      # @return [Object]
+      # @return [AccountModel[]]
       def create_account(model)
         path = "/api/v2/accounts"
         post(path, model)

data/lib/avatax/client/taxcontent.rb

@@ -72,6 +72,23 @@ module AvaTax
       # to reconcile the actual transaction and determine the difference between the estimated general tax
       # rate and the final transaction tax.
       #
+      # The file provided by this API is in CSV format with the following columns:
+      #
+      # * ZIP_CODE - The five digit zip code for this record.
+      # * STATE_ABBREV - A valid two character US state abbreviation for this record. Zip codes may span multiple states.
+      # * COUNTY_NAME - A valid county name for this record. Zip codes may span multiple counties.
+      # * CITY_NAME - A valid city name for this record. Zip codes may span multiple cities.
+      # * STATE_SALES_TAX - The state component of the sales tax rate.
+      # * STATE_USE_TAX - The state component of the use tax rate.
+      # * COUNTY_SALES_TAX - The county component of the sales tax rate.
+      # * COUNTY_USE_TAX - The county component of the use tax rate.
+      # * CITY_SALES_TAX - The city component of the sales tax rate.
+      # * CITY_USE_TAX - The city component of the use tax rate.
+      # * TOTAL_SALES_TAX - The total tax rate for sales tax for this postal code. This value may not equal the sum of the state/county/city due to special tax jurisdiction rules.
+      # * TOTAL_USE_TAX - The total tax rate for use tax for this postal code. This value may not equal the sum of the state/county/city due to special tax jurisdiction rules.
+      # * TAX_SHIPPING_ALONE - This column contains 'Y' if shipping is taxable.
+      # * TAX_SHIPPING_AND_HANDLING_TOGETHER - This column contains 'Y' if shipping and handling are taxable when sent together.
+      #
       # For more detailed tax content, please use the `BuildTaxContentFile` API which allows usage of exact items and exact locations.
       # @param date [DateTime] The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31
       # @param region [String] If the region is provided, this API is going to generate the tax rate per zipcode for only the region specified.

data/lib/avatax/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 18.4.1
+  version: 18.5.1
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake