avatax 19.5.0 → 19.9.1

data/lib/avatax/client/notifications.rb

@@ -18,6 +18,8 @@ module AvaTax
       # dismissed. You can then later review which employees of your company dismissed notifications to
       # determine if they were resolved appropriately.
       #
+      # A Global notification with null accountId and companyId cannot be dismissed and will expire within a given time span.
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.

data/lib/avatax/client/registrar.rb

@@ -32,6 +32,9 @@ module AvaTax
       # to regularly review notifications and then dismiss them when you are certain that you have addressed
       # any relevant concerns raised by this notification.
       #
+      # A Global notification is a message which is directed to all the accounts and is set to expire within
+      # a certain time and cannot be dismissed by the user. Make accountId and companyId null to create a global notification.
+      #
       # An example of a notification would be a message about new software, or a change to AvaTax that may
       # affect you, or a potential issue with your company's tax profile.
       #

data/lib/avatax/client/reports.rb

@@ -31,29 +31,6 @@ module AvaTax
       end
 
 
-      # Intiate and download an ExportDocumentLine report
-      #
-      # This API is deprecated.
-      #
-      # Please use the asynchronous reports APIs:
-      #
-      # * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
-      # * In the result of the Initiate API, you receive back a report's `id` value.
-      # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
-      # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @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]
-      def export_document_line(companyId, model)
-        path = "/api/v2/companies/#{companyId}/reports/exportdocumentline"
-        post(path, model)
-      end
-
-
       # Retrieve a single report
       #
       # Retrieve a single report by its unique ID number.
@@ -118,10 +95,10 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, 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:* reportType, parameters, createdUser, completedDate
-      # @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 companyId [Integer] The id of the company for which to get reports.
+      # @param pageKey [String] Provide a page key to retrieve the next page of results.
       # @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 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.
       # @return [FetchResult]
       def list_reports(options={})
         path = "/api/v2/reports"

data/lib/avatax/client/taxcontent.rb

@@ -131,7 +131,7 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @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.
+      # @param region [String] A two character region code which limits results to a specific region.
       # @return [Object]
       def download_tax_rates_by_zip_code(date, options={})
         path = "/api/v2/taxratesbyzipcode/download/#{date}"

data/lib/avatax/client/transactions.rb

@@ -63,6 +63,11 @@ module AvaTax
       # * LinesOnly (omit details - reduces API response size)
       # * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -97,6 +102,11 @@ module AvaTax
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
       # sales, purchases, inventory transfer, and returns (also called refunds).
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -128,6 +138,11 @@ module AvaTax
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
       # sales, purchases, inventory transfer, and returns (also called refunds).
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -155,7 +170,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires the user role Compliance Root User.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
+      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param model [Object] bulk lock request
       # @return [Object]
@@ -189,6 +204,11 @@ module AvaTax
       # * LinesOnly (omit details - reduces API response size)
       # * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
@@ -228,6 +248,11 @@ module AvaTax
       # * LinesOnly (omit details - reduces API response size)
       # * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
@@ -274,6 +299,11 @@ module AvaTax
       #
       # If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
       #
+      # NOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently:
+      # * \_-ava2f-\_
+      # * \_-ava2b-\_
+      # * \_-ava3f-\_
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -325,6 +355,11 @@ module AvaTax
       #
       # If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
       #
+      # NOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently:
+      # * \_-ava2f-\_
+      # * \_-ava2b-\_
+      # * \_-ava3f-\_
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -392,6 +427,11 @@ module AvaTax
       # * SummaryOnly (omit lines and details - reduces API response size)
       # * LinesOnly (omit details - reduces API response size)
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -411,6 +451,11 @@ module AvaTax
       #
       # DEPRECATED: Please use the `GetTransactionByCode` API instead.
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -483,6 +528,11 @@ module AvaTax
       # * SummaryOnly (omit lines and details - reduces API response size)
       # * LinesOnly (omit details - reduces API response size)
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -525,10 +575,15 @@ module AvaTax
       # * LinesOnly (omit details - reduces API response size)
       # * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
+      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to lock
       # @param documentType [String] (Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
@@ -575,6 +630,11 @@ module AvaTax
       # * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
       # If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -615,6 +675,11 @@ module AvaTax
       # * LinesOnly (omit details - reduces API response size)
       # * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
@@ -647,13 +712,18 @@ module AvaTax
       # * LinesOnly (omit details - reduces API response size)
       # * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
       # @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)
+      # @param transactionCode [String] The transaction code to Uncommit
+      # @param documentType [String] (Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def uncommit_transaction(companyCode, transactionCode, options={})
@@ -676,6 +746,11 @@ module AvaTax
       # * LinesOnly (omit details - reduces API response size)
       # * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -712,6 +787,11 @@ module AvaTax
       # * LinesOnly (omit details - reduces API response size)
       # * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
@@ -751,6 +831,11 @@ module AvaTax
       # * LinesOnly (omit details - reduces API response size)
       # * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
       #
+      # NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
+      # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
+      # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.

data/lib/avatax/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 19.5.0
+  version: 19.9.1
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2019-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -147,8 +147,10 @@ files:
 - lib/avatax/client/definitions.rb
 - lib/avatax/client/distancethresholds.rb
 - lib/avatax/client/ecms.rb
+- lib/avatax/client/errortransactions.rb
 - lib/avatax/client/filingcalendars.rb
 - lib/avatax/client/filings.rb
+- lib/avatax/client/firmclientlinkages.rb
 - lib/avatax/client/free.rb
 - lib/avatax/client/fundingrequests.rb
 - lib/avatax/client/items.rb
@@ -215,14 +217,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the AvaTax API
-test_files:
-- spec/avatax/client/accounts_spec.rb
-- spec/avatax/client/transactions_spec.rb
-- spec/avatax_spec.rb
-- spec/credentials.yaml.example
-- spec/fixtures/accounts.json
-- spec/spec_helper.rb
+test_files: []