avatax 18.2.0 → 18.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 355cf5ee71fbeb8b960cf1944d959ca8dc81a59d2f1917dc0021b38e939dccc8
-  data.tar.gz: f5599aa2d9cf2307f3e09ee6a006e0da035a5fe1681ed50699ab85bf7a07c074
+  metadata.gz: e958b89aba3505f4199e21ec24f221dae29901786ec82b44e200cbb472fc9f3b
+  data.tar.gz: 21c69e8f8af01a8d9757fd7af0783ca13fd17295654cde54bdb175ca85d81102
 SHA512:
-  metadata.gz: 8a5efe0d12112e77085d9831a02051c65e76786e8d6846249ff0f81b78b28e3ea95935b38e4f98600968a2b5bbf340ebaf419aab30483c44f30a9a3c5d2c3ab2
-  data.tar.gz: cec459683d2a5431a1a3b8fe5fe4b442a85c1e8504d74c0ae1d935f27ac01fca5f58dfcbcb792bff883e17f3251fc7ce818ba11a90e3f6d4239fe2dc075a6dc4
+  metadata.gz: e573d0641296e7a4da87756eae0b6f7d7b5133a4d45001df07d70865855d0166be6984f1f1467c1f71cec0e47e21eee57d1a6f44a59c69622406c00b7537fcdc
+  data.tar.gz: a5bb454a18e0f6568013907a2a0d90cfba8b15bb295f8603312ebb2ee0955d16450b82c299aa4017cc4ac94b709fc481a126c7ae613e7930064a170a154cea9a

data/lib/avatax/client/avafileforms.rb

@@ -0,0 +1,70 @@
+module AvaTax
+  class Client
+    module AvaFileForms 
+
+
+      # Create a new AvaFileForm
+      #
+      # Create one or more AvaFileForms
+      # A 'AvaFileForm' represents a form supported by our returns team
+      # @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
+      # @return [AvaFileFormModel[]]
+      def create_ava_file_forms(model)
+        path = "/api/v2/avafileforms"
+        post(path, model)
+      end
+
+
+      # Delete a single AvaFileForm
+      #
+      # Marks the existing AvaFileForm object at this URL as deleted.
+      # @param id [Integer] The ID of the AvaFileForm you wish to delete.
+      # @return [ErrorDetail[]]
+      def delete_ava_file_form(id)
+        path = "/api/v2/avafileforms/#{id}"
+        delete(path)
+      end
+
+
+      # Retrieve a single AvaFileForm
+      #
+      # Get the AvaFileForm object identified by this URL.
+      # @param id [String] The primary key of this AvaFileForm
+      # @return [Object]
+      def get_ava_file_form(id)
+        path = "/api/v2/avafileforms/#{id}"
+        get(path)
+      end
+
+
+      # Retrieve all AvaFileForms
+      #
+      # 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 filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # @param include [String] A comma separated list of additional data to retrieve.
+      # @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 query_ava_file_forms(options={})
+        path = "/api/v2/avafileforms"
+        get(path, options)
+      end
+
+
+      # Update a AvaFileForm
+      #
+      # 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.
+      # @param id [Integer] The ID of the AvaFileForm you wish to update
+      # @param model [Object] The AvaFileForm model you wish to update.
+      # @return [Object]
+      def update_ava_file_form(id, model)
+        path = "/api/v2/avafileforms/#{id}"
+        put(path, model)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/batches.rb

@@ -6,9 +6,19 @@ module AvaTax
       # Create a new batch
       #
       # Create one or more new batch objects attached to this company.
-      # When you create a batch, it is added to the AvaTaxBatch.Batch table and will be processed in the order it was received.
-      # You may fetch a batch to check on its status and retrieve the results of the batch operation.
+      #
       # Each batch object may have one or more file objects (currently only one file is supported).
+      #
+      # When a batch is created, it is added to the AvaTax Batch Queue and will be
+      # processed as quickly as possible in the order it was received. To check the
+      # status of a batch, fetch the batch and retrieve the results of the batch
+      # operation.
+      #
+      # 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 model [BatchModel[]] The batch you wish to create.
       # @return [BatchModel[]]
@@ -22,7 +32,7 @@ module AvaTax
       #
       # 
       # @param companyId [Integer] The ID of the company that owns this batch.
-      # @param id [Integer] The ID of the batch you wish to delete.
+      # @param id [Integer] The ID of the batch to delete.
       # @return [ErrorDetail[]]
       def delete_batch(companyId, id)
         path = "/api/v2/companies/#{companyId}/batches/#{id}"
@@ -45,10 +55,21 @@ module AvaTax
 
       # Retrieve a single batch
       #
-      # Get the batch object identified by this URL.
-      # A batch object is a large collection of API calls stored in a compact file.
-      # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
-      # You may fetch a batch to check on its status and retrieve the results of the batch operation.
+      # Get the batch object identified by this URL. A batch object is a large
+      # collection of API calls stored in a compact file.
+      #
+      # Use this endpoint to retrieve the results or check the status of a batch.
+      #
+      # When a batch is created, it is added to the AvaTax Batch Queue and will be
+      # processed as quickly as possible in the order it was received. To check the
+      # status of a batch, fetch the batch and retrieve the results of the batch
+      # operation.
+      #
+      # 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 primary key of this batch
       # @return [Object]
@@ -61,11 +82,26 @@ module AvaTax
       # Retrieve all batches for this company
       #
       # List all batch objects attached to the specified company.
+      #
       # A batch object is a large collection of API calls stored in a compact file.
-      # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
-      # You may fetch a batch to check on its status and retrieve the results of the batch operation.
-      # 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.
+      #
+      # 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 results using the `$top`, `$skip`, and `$orderby` parameters.
+      #
+      # Use [GetBatch](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Batches/GetBatch/)
+      # to retrieve the results, or check the status, of an individual batch.
+      #
+      # When a batch is created, it is added to the AvaTax Batch Queue and will be
+      # processed as quickly as possible in the order it was received. To check the
+      # status of a batch, fetch the batch and retrieve the results of the batch
+      # operation.
+      #
+      # 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 these batches
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
@@ -82,12 +118,23 @@ module AvaTax
       # Retrieve all batches
       #
       # Get multiple batch objects across all companies.
+      #
       # A batch object is a large collection of API calls stored in a compact file.
-      # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
-      # You may fetch a batch to check on its status and retrieve the results of the batch operation.
       #
-      # 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.
+      # 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 results using the `$top`, `$skip`, and `$orderby` parameters.
+      #
+      # When a batch is created, it is added to the AvaTax Batch Queue and will be
+      # processed as quickly as possible in the order it was received. To check the
+      # status of a batch, fetch the batch and retrieve the results of the batch
+      # operation.
+      #
+      # 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 filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
       # @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/customers.rb

@@ -62,6 +62,7 @@ module AvaTax
       # You can use the `$include` parameter to fetch the following additional objects for expansion:
       #
       # * Certificates - Fetch a list of certificates linked to this customer.
+      # * CustomFields - Fetch a list of custom fields associated to this customer.
       #
       # 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

data/lib/avatax/client/definitions.rb

@@ -214,10 +214,14 @@ module AvaTax
       # This API is intended to be useful to identify the correct HS Code to use for your item.
       # @param country [String] The name or code of the destination country.
       # @param hsCode [String] The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available.
+      # @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_cross_border_codes(country, hsCode)
+      def list_cross_border_codes(country, hsCode, options={})
         path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
-        get(path)
+        get(path, options)
       end
 
 

data/lib/avatax/client/transactions.rb

@@ -289,9 +289,13 @@ module AvaTax
 
       # Retrieve a single transaction by code
       #
-      # Get the current `SalesInvoice` transaction identified by this URL.
+      # Get the current transaction identified by this company code, transaction code, and document type.
       #
-      # To fetch other kinds of transactions, use `GetTransactionByCodeAndType`.
+      # A transaction is uniquely identified by `companyCode`, `code` (often called Transaction Code), and `documentType`.
+      #
+      # For compatibility purposes, when this API finds multiple transactions with the same transaction code, and if you have not specified
+      # the `type` parameter to this API, it will default to selecting the `SalesInvoices` transaction. To change this behavior, use the
+      # optional `documentType` parameter to specify the specific document type you wish to find.
       #
       # If this transaction was adjusted, the return value of this API will be the current transaction with this code.
       #
@@ -305,6 +309,7 @@ module AvaTax
       # * LinesOnly (omit details - reduces API response size)
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to retrieve
+      # @param documentType [String] (Optional): The document type of the transaction to retrieve (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def get_transaction_by_code(companyCode, transactionCode, options={})
@@ -315,18 +320,7 @@ module AvaTax
 
       # Retrieve a single transaction by code
       #
-      # Get the current transaction identified by this URL.
-      #
-      # If this transaction was adjusted, the return value of this API will be the current transaction with this code.
-      #
-      # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
-      #
-      # * Lines
-      # * Details (implies lines)
-      # * Summary (implies details)
-      # * Addresses
-      # * SummaryOnly (omit lines and details - reduces API response size)
-      # * LinesOnly (omit details - reduces API response size)
+      # DEPRECATED: Please use the `GetTransactionByCode` API instead.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to retrieve
       # @param documentType [String] The transaction type to retrieve (See DocumentType::* for a list of allowable values)
@@ -462,6 +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 model [Object] Information about the refund to create
       # @return [Object]
       def refund_transaction(companyCode, transactionCode, model, options={})

data/lib/avatax/client/users.rb

@@ -63,11 +63,28 @@ module AvaTax
       end
 
 
+      # Get information about a username.
+      #
+      # You may call this API prior to creating a user, to check if a particular username is available for use. Using this API, you can
+      # present a friendly experience prior to attempting to create a new user object.
+      #
+      # Please ensure that the query string is url encoded if you wish to check information for a user that contains url-sensitive characters.
+      # @param username [String] The username to search.
+      # @return [Object]
+      def get_username(options={})
+        path = "/api/v2/usernames"
+        get(path, options)
+      end
+
+
       # Retrieve users for this account
       #
       # List all user objects attached to this account.
       # A user represents one person with access privileges to make API calls and work with a specific account.
       #
+      # When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key.
+      # By default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users.
+      #
       # 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 accountId [Integer] The accountID of the user you wish to list.
@@ -86,7 +103,12 @@ module AvaTax
       # Retrieve all users
       #
       # Get multiple user objects across all accounts.
-      # A user represents one person with access privileges to make API calls and work with a specific account.
+      #
+      # A user represents one person or set of credentials with access privileges to make API calls and work with a specific account. A user can be authenticated
+      # via either username / password authentication, an OpenID / OAuth Bearer Token, or a legacy AvaTax License Key.
+      #
+      # When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key.
+      # By default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users.
       #
       # 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.

data/lib/avatax/version.rb

@@ -1,3 +1,3 @@
 module AvaTax
-  VERSION = '18.2.0'.freeze unless defined?(::AvaTax::VERSION)
+  VERSION = '18.3.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.2.0
+  version: 18.3.0
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-09 00:00:00.000000000 Z
+date: 2018-03-27 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/avafileforms.rb
 - lib/avatax/client/batches.rb
 - lib/avatax/client/certexpressinvites.rb
 - lib/avatax/client/certificates.rb