avatax 18.3.0 → 18.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e958b89aba3505f4199e21ec24f221dae29901786ec82b44e200cbb472fc9f3b
-  data.tar.gz: 21c69e8f8af01a8d9757fd7af0783ca13fd17295654cde54bdb175ca85d81102
+  metadata.gz: add871ab3afdc0119f99b02c044b02bd8225ecf932a5b6d03a05dca34b634c42
+  data.tar.gz: 81010bad716cfc21394149b55922060a35a17d1246e330c489a66bac65678c96
 SHA512:
-  metadata.gz: e573d0641296e7a4da87756eae0b6f7d7b5133a4d45001df07d70865855d0166be6984f1f1467c1f71cec0e47e21eee57d1a6f44a59c69622406c00b7537fcdc
-  data.tar.gz: a5bb454a18e0f6568013907a2a0d90cfba8b15bb295f8603312ebb2ee0955d16450b82c299aa4017cc4ac94b709fc481a126c7ae613e7930064a170a154cea9a
+  metadata.gz: 5d017ab32652887888d279f02ff25b4dff502c0c37d5d94baf43c9cd48d0a8b9473a6e094e44d418bed5202bb348cc7a214c7d39724576bee5d8849b1f7e83ee
+  data.tar.gz: 5c56513540926d23b348b4f3c3e7a861c0f23a3403f21523ff5e76d1f93bebd5f1f92d197d60801a9db1549783540ca246ab6089553bd034a0150282f798aab6

data/lib/avatax/client/advancedrules.rb

@@ -0,0 +1,135 @@
+module AvaTax
+  class Client
+    module AdvancedRules 
+
+
+      # Approve an advanced rule script to 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] The ID of the account that owns the Advanced Rule.
+      # @param scriptType [String] The script transform type: Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
+      # @return [Object]
+      def approve_advanced_rule_script(accountId, scriptType)
+        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}/approve"
+        post(path)
+      end
+
+
+      # Create an advanced rule.
+      #
+      # 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] The ID of the account that will own the Advanced Rule.
+      # @param scriptType [String] The script transform type, Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
+      # @param crashBehavior [String] The behavior the script should take if it crashes: Fail or Proceed. (See AdvancedRuleCrashBehavior::* for a list of allowable values)
+      # @param file [Object] The JavaScript file containing the advanced rule.
+      # @return [String]
+      def create_advanced_rule_script(accountId, scriptType, options={})
+        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}"
+        post(path, options)
+      end
+
+
+      # Create a lookup table for an advanced rule
+      #
+      # 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] The ID of the account that owns the Advanced Rule.
+      # @param csvTableName [String] The name to assign the CSV lookup table.
+      # @param file [Object] A CSV file containing lookup data for an advanced rule.
+      # @return [String]
+      def create_advanced_rule_table(accountId, csvTableName)
+        path = "/api/v2/accounts/#{accountId}/advancedruletables/#{csvTableName}"
+        post(path)
+      end
+
+
+      # Delete an account's active advanced rule
+      #
+      # 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] The ID of the account that owns the Advanced Rule.
+      # @param scriptType [String] The script transform type: Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
+      # @return [ErrorDetail[]]
+      def delete_advanced_rule_script(accountId, scriptType)
+        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}"
+        delete(path)
+      end
+
+
+      # Delete a lookup table for an advanced rule.
+      #
+      # 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] The ID of the account that owns the Advanced Rule.
+      # @param csvTableName [String] The name of the CSV lookup table to delete.
+      # @return [ErrorDetail[]]
+      def delete_advanced_rule_table(accountId, csvTableName)
+        path = "/api/v2/accounts/#{accountId}/advancedruletables/#{csvTableName}"
+        delete(path)
+      end
+
+
+      # Get an account's advanced rule script.
+      #
+      # 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] The ID of the account that owns the Advanced Rule.
+      # @param scriptType [String] The script transform type: Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
+      # @return [Object]
+      def get_advanced_rule_script(accountId, scriptType)
+        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}"
+        get(path)
+      end
+
+
+      # Get an advanced rule lookup table for an account
+      #
+      # 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] The ID of the account that owns the Advanced Rule.
+      # @param csvTableName [String] The name of the CSV lookup table to get.
+      # @return [Object]
+      def get_advanced_rule_table(accountId, csvTableName)
+        path = "/api/v2/accounts/#{accountId}/advancedruletables/#{csvTableName}"
+        get(path)
+      end
+
+
+      # Get all advanced rule lookup tables for an account
+      #
+      # 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] The ID of the account that owns the Advanced Rule.
+      # @return [Object]
+      def get_advanced_rule_tables(accountId)
+        path = "/api/v2/accounts/#{accountId}/advancedruletables"
+        get(path)
+      end
+
+
+      # Unapprove an advanced rule script 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] The ID of the account that owns the Advanced Rule.
+      # @param scriptType [String] The script transform type: Request or Response. (See AdvancedRuleScriptType::* for a list of allowable values)
+      # @return [Object]
+      def unapprove_advanced_rule_script(accountId, scriptType)
+        path = "/api/v2/accounts/#{accountId}/advancedrulescripts/#{scriptType}/unapprove"
+        post(path)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/customers.rb

@@ -13,6 +13,9 @@ module AvaTax
       # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
+      # A nested object such as CustomFields could be specified and created along with the customer object. To fetch the
+      # nested object, please call 'GetCustomer' API with appropriate $include parameters.
+      #
       # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
       # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
       # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document

data/lib/avatax/client/definitions.rb

@@ -79,7 +79,7 @@ module AvaTax
       end
 
 
-      # List certificate attributes used by a company
+      # List the certificate exempt reasons defined by a company
       #
       # List the certificate exempt reasons defined by a company.
       #
@@ -119,10 +119,9 @@ module AvaTax
       end
 
 
-      # Retrieve the full list of communications transactiontypes
+      # Retrieve the full list of communications service types
       #
-      # Returns full list of communications transaction types which
-      # are accepted in communication tax calculation requests.
+      # Returns full list of service types for a given transaction type ID.
       # @param id [Integer] The transaction type ID to examine
       # @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.

data/lib/avatax/client/free.rb

@@ -7,7 +7,7 @@ module AvaTax
       #
       # Call this API to obtain a free AvaTax sandbox account.
       #
-      # This API is free to use. No authentication credentials are required to call this 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.
       # 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.
       #

data/lib/avatax/client/nexus.rb

@@ -13,7 +13,7 @@ module AvaTax
       # Note that not all fields within a nexus can be updated; Avalara publishes a list of all defined nexus at the
       # '/api/v2/definitions/nexus' endpoint.
       # You may only define nexus matching the official list of declared nexus.
-      # Please allow 1 minute before start using the created Nexus in your transactions.
+      # Please allow 1 minute before using the created nexus in your transactions.
       # @param companyId [Integer] The ID of the company that owns this nexus.
       # @param model [NexusModel[]] The nexus you wish to create.
       # @return [NexusModel[]]
@@ -23,6 +23,33 @@ module AvaTax
       end
 
 
+      # Creates nexus for a list of addresses.
+      #
+      # This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this
+      # API declares nexus for this company, for the list of addresses provided,
+      # for the date range provided. You may also use this API to extend effective date on an already-declared nexus.
+      #
+      # The concept of 'Nexus' indicates a place where your company has sufficient physical presence and is obligated
+      # to collect and remit transaction-based taxes.
+      #
+      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
+      # in all jurisdictions affected by your transactions.
+      #
+      # Note that not all fields within a nexus can be updated; Avalara publishes a list of all defined nexus at the
+      # '/api/v2/definitions/nexus' endpoint.
+      #
+      # You may only define nexus matching the official list of declared nexus.
+      #
+      # Please allow 1 minute before using the created nexus in your transactions.
+      # @param companyId [Integer] The ID of the company that will own this nexus.
+      # @param model [DeclareNexusByAddressModel[]] The nexus you wish to create.
+      # @return [NexusByAddressModel[]]
+      def declare_nexus_by_address(companyId, model)
+        path = "/api/v2/companies/#{companyId}/nexus/byaddress"
+        post(path, model)
+      end
+
+
       # Delete a single nexus
       #
       # Marks the existing nexus object at this URL as deleted.
@@ -131,7 +158,7 @@ module AvaTax
       # You may only define nexus matching the official list of declared nexus.
       # 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.
-      # Please allow 1 minute to start seeing your updated Nexus taking effect on your transactions.
+      # Please allow 1 minute for your updated Nexus to take effect on your transactions.
       # @param companyId [Integer] The ID of the company that this nexus belongs to.
       # @param id [Integer] The ID of the nexus you wish to update
       # @param model [Object] The nexus object you wish to update.

data/lib/avatax/client/reports.rb

@@ -82,7 +82,7 @@ module AvaTax
       # The `ExportDocumentLine` report produces information about invoice lines recorded within your account.
       # @param companyId [Integer] The unique ID number of the company to report on.
       # @param model [Object] Options that may be configured to customize the report.
-      # @return [Object]
+      # @return [ReportModel[]]
       def initiate_export_document_line_report(companyId, model)
         path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
         post(path, model)

data/lib/avatax/client/settings.rb

@@ -6,12 +6,15 @@ module AvaTax
       # Create a new setting
       #
       # Create one or more new setting objects attached to this company.
-      # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
-      # not defined or managed by Avalara.
-      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
-      # 'value' data fields.
-      # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
-      # the 'set' data field.
+      #
+      # The company settings system is a metadata system that you can use to store extra information
+      # about a company. Your integration or connector could use this data storage to keep track of
+      # preference information, reminders, or any other storage that would need to persist even if
+      # the customer uninstalls your application.
+      #
+      # A setting can refer to any type of data you need to remember about this company object.
+      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
+      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
       # @param companyId [Integer] The ID of the company that owns this setting.
       # @param model [SettingModel[]] The setting you wish to create.
       # @return [SettingModel[]]
@@ -24,6 +27,15 @@ module AvaTax
       # Delete a single setting
       #
       # Mark the setting object at this URL as deleted.
+      #
+      # The company settings system is a metadata system that you can use to store extra information
+      # about a company. Your integration or connector could use this data storage to keep track of
+      # preference information, reminders, or any other storage that would need to persist even if
+      # the customer uninstalls your application.
+      #
+      # A setting can refer to any type of data you need to remember about this company object.
+      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
+      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
       # @param companyId [Integer] The ID of the company that owns this setting.
       # @param id [Integer] The ID of the setting you wish to delete.
       # @return [ErrorDetail[]]
@@ -36,12 +48,15 @@ module AvaTax
       # Retrieve a single setting
       #
       # Get a single setting object by its unique ID.
-      # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
-      # not defined or managed by Avalara.
-      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
-      # 'value' data fields.
-      # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
-      # the 'set' data field.
+      #
+      # The company settings system is a metadata system that you can use to store extra information
+      # about a company. Your integration or connector could use this data storage to keep track of
+      # preference information, reminders, or any other storage that would need to persist even if
+      # the customer uninstalls your application.
+      #
+      # A setting can refer to any type of data you need to remember about this company object.
+      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
+      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
       # @param companyId [Integer] The ID of the company that owns this setting
       # @param id [Integer] The primary key of this setting
       # @return [Object]
@@ -54,12 +69,15 @@ module AvaTax
       # Retrieve all settings for this company
       #
       # List all setting objects attached to this company.
-      # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
-      # not defined or managed by Avalara.
-      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
-      # 'value' data fields.
-      # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
-      # the 'set' data field.
+      #
+      # The company settings system is a metadata system that you can use to store extra information
+      # about a company. Your integration or connector could use this data storage to keep track of
+      # preference information, reminders, or any other storage that would need to persist even if
+      # the customer uninstalls your application.
+      #
+      # A setting can refer to any type of data you need to remember about this company object.
+      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
+      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
       #
       # 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.
@@ -79,12 +97,15 @@ module AvaTax
       # Retrieve all settings
       #
       # Get multiple setting objects across all companies.
-      # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
-      # not defined or managed by Avalara.
-      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
-      # 'value' data fields.
-      # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
-      # the 'set' data field.
+      #
+      # The company settings system is a metadata system that you can use to store extra information
+      # about a company. Your integration or connector could use this data storage to keep track of
+      # preference information, reminders, or any other storage that would need to persist even if
+      # the customer uninstalls your application.
+      #
+      # A setting can refer to any type of data you need to remember about this company object.
+      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
+      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
       #
       # 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.
@@ -103,14 +124,19 @@ module AvaTax
       # Update a single setting
       #
       # Replace the existing setting object at this URL with an updated object.
-      # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
-      # not defined or managed by Avalara.
-      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
-      # 'value' data fields.
-      # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
-      # the 'set' data field.
-      # 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.
+      #
+      # The company settings system is a metadata system that you can use to store extra information
+      # about a company. Your integration or connector could use this data storage to keep track of
+      # preference information, reminders, or any other storage that would need to persist even if
+      # the customer uninstalls your application.
+      #
+      # A setting can refer to any type of data you need to remember about this company object.
+      # When creating this object, you may define your own `set`, `name`, and `value` parameters.
+      # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
+      #
+      # 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 when calling update.
       # @param companyId [Integer] The ID of the company that this setting belongs to.
       # @param id [Integer] The ID of the setting you wish to update
       # @param model [Object] The setting you wish to update.

data/lib/avatax/client/taxcontent.rb

@@ -46,7 +46,7 @@ module AvaTax
       # @param date [DateTime] The date for which point-of-sale data would be calculated (today by default)
       # @param format [String] The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values)
       # @param partnerId [String] If specified, requests a custom partner-formatted version of the file. (See PointOfSalePartnerId::* for a list of allowable values)
-      # @param includeJurisCodes [object] When true, the file will include jurisdiction codes in the result.
+      # @param includeJurisCodes [Boolean] When true, the file will include jurisdiction codes in the result.
       # @return [Object]
       def build_tax_content_file_for_location(companyId, id, options={})
         path = "/api/v2/companies/#{companyId}/locations/#{id}/pointofsaledata"
@@ -74,10 +74,11 @@ module AvaTax
       #
       # 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.
       # @return [Object]
-      def download_tax_rates_by_zip_code(date)
+      def download_tax_rates_by_zip_code(date, options={})
         path = "/api/v2/taxratesbyzipcode/download/#{date}"
-        get(path)
+        get(path, options)
       end
 
     end

data/lib/avatax/client/transactions.rb

@@ -456,7 +456,7 @@ module AvaTax
       # @param transactionCode [String] The transaction code of the original sale
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param documentType [String] (Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
-      # @param useTaxDateOverride [object] (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).
+      # @param useTaxDateOverride [Boolean] (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).
       # @param model [Object] Information about the refund to create
       # @return [Object]
       def refund_transaction(companyCode, transactionCode, model, options={})
@@ -488,6 +488,22 @@ module AvaTax
       end
 
 
+      # Uncommit a transaction for reporting
+      #
+      # Adjusts a transaction by changing it to an uncommitted status.
+      #
+      # Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are
+      # no longer available to be uncommitted.
+      # @param companyCode [String] The company code of the company that recorded this transaction
+      # @param transactionCode [String] The transaction code to commit
+      # @param documentType [String] (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
+      # @return [Object]
+      def uncommit_transaction(companyCode, transactionCode, options={})
+        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/uncommit"
+        post(path, options)
+      end
+
+
       # Verify a transaction
       #
       # Verifies that the transaction uniquely identified by this URL matches certain expected values.

data/lib/avatax/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 18.3.0
+  version: 18.4.0
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -145,6 +145,7 @@ files:
 - lib/avatax/client.rb
 - lib/avatax/client/accounts.rb
 - lib/avatax/client/addresses.rb
+- lib/avatax/client/advancedrules.rb
 - lib/avatax/client/avafileforms.rb
 - lib/avatax/client/batches.rb
 - lib/avatax/client/certexpressinvites.rb